QuickObjects.ObjectBase Send comments on this topic.
BaseFieldValidator Class Members
See Also  Fields  Properties  Methods 
Akal.QuickObjects.ObjectBase Namespace : BaseFieldValidator Class


The following tables list the members exposed by BaseFieldValidator.

Public Constructors

 NameDescription
Public ConstructorBaseFieldValidator ConstructorOverloaded. Default Constructor - provides no special functionality.  
Top

Protected Fields

 NameDescription
Protected Field_errorString  
Top

Public Properties

 NameDescription
Public PropertyCustomErrorMessage CustomErrorMessage can be used to specify the error message that will be formatted and returned instead of the standard error message.

NOTE: Formatting can be specified by using {0} and {1} place holders inside the string.

The following place holders can be used:

  • {0} will be replaced with the field's name or alias [GetResultSetName() method]

  • {1} will be replaced with the business object's name or alias [GetResultSetName() method].

  • {2} will be replaced with the actual value of the field.

  • {3} will be replaced with the minimum required length (only application to StringField).

  • {4} will be replaced with the maximum possible length (only application to StringField).

 
Public PropertyEnabled Enabled property can be used to easily turn off or on a validator. If the value of Enabled is set to false, this validator will not be used in validation.  
Public PropertyErrorStringIf the validation fails the error message is available via this property.

If the CustomErrorMessage is set, the ErrorString property will automatically return the CustomErrorMessage after formatting it.

 
Public PropertyFieldToValidateField instance that will be validated by this validation.  
Public PropertyIsValid Returns true if the validation is valid or the FieldToValidate property is null.  
Public PropertyName Used to uniquely identify each validator. When a new Field instance is passed into the constructor or the FieldToValidate property is set, the Name property is automatically populated, hence it is not required to set this value. Setting this value to a custom name will help you access this validator instance from the Validators collection by using the custom name.  
Public PropertyValidatorType ValidatorType - Returns the value ValidatorTypes.BaseFieldValidator.  
Top

Public Methods

 NameDescription
Public MethodGetValidatorTypeName GetValidatorTypeName - Returns a string representation of the current validator type.  
Public MethodValidate Returns false if the validator fails. If the FieldToValidate is null then then this method returns true.  
Top

See Also