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


The following tables list the members exposed by CompareFieldValidator.

Public Constructors

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

Protected Fields

 NameDescription
Protected Field_errorString (Inherited from BaseFieldValidator)
Top

Public Properties

 NameDescription
Public PropertyComparisonType ComparisonType property is used by the field validation to compare the value to the value of the FieldToCompare field.  
Public PropertyCustomErrorMessageOverridden.  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 comparison type being performed.

  • {4} will be replaced with the name or alias of the field being compared.

  • {5} will be replaced with the name or alias of the business object of the field being compared.

 
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. (Inherited from BaseFieldValidator)
Public PropertyErrorStringOverridden. If 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 PropertyFieldToCompare Field that will be used to compare values. Comparison will be based on the ComparisonType property.  
Public PropertyFieldToValidateField instance that will be validated by this validation. (Inherited from BaseFieldValidator)
Public PropertyIsNullValid IsNullValid - When set to true, this validator returns true even if the field value is null.  
Public PropertyIsValid Returns true if the validation is valid or the FieldToValidate property is null. (Inherited from BaseFieldValidator)
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. (Inherited from BaseFieldValidator)
Public PropertyValidatorTypeOverridden.  ValidatorType - Returns the value ValidatorTypes.CompareFieldValidator.  
Top

Public Methods

 NameDescription
Public MethodGetValidatorTypeNameOverridden.  GetValidatorTypeName - Returns string value for the validator type.  
Public MethodValidateOverridden.  Returns false if the validator fails. If the FieldToValidate is null then then this method returns true.  
Top

See Also