CompareRule

A validation rule that demands that a validated editor has a value that equals to a specified expression.

Type: Object

To specify the expression that the validated field must match, set the rule's comparisonTarget configuration option. Assign a function to this option. The validated value will be compared to the function's return value. The comparison will be performed by using the operator that is set for the comparisonType option.

Show Example:
AngularJS
Knockout
jQuery

In this example, the 'compare' rule is applied to the 'Confirm your password' editor. This rule demands that the value of this editor equals to the value specified within the 'Password' editor. To check this rule, specify different passwords in the editors.


                                    

                                    

In this example, the 'compare' rule is applied to the 'Confirm your password' editor. This rule demands that the value of this editor equals to the value specified within the 'Password' editor. To check this rule, specify different passwords in the editors.


                                    

                                    

In this example, the 'compare' rule is applied to the 'Confirm your password' editor. This rule demands that the value of this editor equals to the value specified within the 'Password' editor. To check this rule, specify different passwords in the editors.


                                    

                                    

comparisonTarget

Specifies the function whose return value is used for comparison with the validated value.

Type: function
Return Value: Object
A value to be compared with the validated value.

The rule is valid if the validated value equals to the return value of the comparisonTarget function.

NOTE
The operator specified by the comparisonType option is used for comparison.

comparisonType

Specifies the operator to be used for comparing the validated value with the target.

Type: String
Default Value: '=='
Accepted Values: '=='|'!='|'==='|'!=='|'>'|'>='|'<'|'<='

message

Specifies the message that is shown for end-users if the current rule is broken.

Type: String
Default Value: 'Values do not match'

You do not have to specify this field. In this instance, a default message will be shown. To include the name of the validated editor into the default validation message as a subject, set the name field of the dxValidator object.

If you assign an empty string to the message field, the message will not be shown.

reevaluate

Indicates whether or not the rule should be always checked for the target value or only when the target value changes.

Type: Boolean
Default Value: true

type

Specifies the type of the current rule.

Type: String
Accepted Values: 'compare'

Set this field to 'compare' to define a rule that will be broken if the validated value does not equal to the return value of the specified comparisonTarget function.