summaryrefslogtreecommitdiff
path: root/demos/quickstart/protected/pages/Controls/Validation.page
blob: 766925cae55b7295974a7f2317cc6813d7d31b2c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<com:TContent ID="body" >

<h1>Validation Controls</h1>

<p>Validation is performed when a postback control, such as a <tt>TButton</tt>, a <tt>TLinkButton</tt> or a <tt>TTextBox</tt> (under AutoPostBack mode) is submitting the page and its <tt><b>CausesValidation</b></tt> property is true.</p>

<p>Validator controls always validate the associated input control on the serve side.
In addition, if <tt>EnableClientScript</tt> is true, validation will also be performed on the client-side using javascript. Client-side validation will validate user input before it is sent to the server. The form data will not be submitted if any error is detected. This avoids the round-trip of information necessary for server-side validation. </p>

<p>Every validator component has the following properties, defined in the <tt>TBaseValidator</tt> class.

<dl>
	<dt>ControlToValidate</dt>
	<dd>The <tt>ID</tt> of the component for this validator. This property must be set to the <tt>ID</tt> path of an input component. The <tt>ID</tt> path is the dot-connected IDs of the components reaching from the validator's parent component to the target component. </dd>

	<dt>ErrorMessage</dt>
	<dd>The text for the error message when the input component failed to validate.</dd>

	<dt>ValidationGroup</dt>
	<dd>If the control causing the validation also sets its ValidationGroup property, only those validators having the same ValidationGroup value will do input validation.
	</dd>

	<dt>Display</dt>
	<dd>The display behavior of the error message in a validation component. The allowed values are: <tt>None</tt>, <tt>Static</tt> and <tt>Dynamic</tt>. The default is <tt>Static</tt>.
	<ul>
		<li><tt>None</tt> -- the validator component and the error message will not be displayed. </li>
		<li><tt>Dynamic</tt> -- CSS for the error is constructed in such a way that space for the error message on the page is NOT reserved. When the user hits the "submit" button, applicable error messages will show up shifting the layout of your page around (usually down). </li>
		<li><tt>Static</tt> -- CSS for the error is constructed in such a way that space for the error message on the page is always reserved. When the user hits the "submit" button, applicable error messages will just show up, not altering the layout of your page. </li>
	</ul>
	</dd>

	<dt>EnableClientScript</dt>
	<dd>Indicating whether client-side validation is enabled. Default is true.</dd>
</dl>


<h2>TRequiredFieldValidator</h2>
<p>
This is the simplest validator, ensuring that the input field has some sort of value. To ensure that all of our input fields are required, add a <tt>TRequiredFieldValidator</tt> component for each of the input fields. The <tt>TRequiredFieldValidator</tt> also has the following property.
</p>
<dl>
	<dt>InitialValue</dt>
	<dd>The associated input component fails validation if its value does not change from the <tt>InitialValue</tt> upon losing focus. </dd>
</dl>

<com:RunBar PagePath="Controls.Samples.TRequiredFieldValidator.Home" />

<h2>TRegularExpressionValidator</h2>
<p>The TRegularExpressionValidator has the following property in addition to the parent <tt>TBaseValidator</tt> properties.
</p>
<dl>
	<dt>RegularExpression</dt>
	<dd>The regular expression that determines the pattern used to validate a field. Some commonly used regular expressions include:
	<ul>
		<li>At least 6 characters: <code>[\w]{6,}</code></li>
		<li>Japanese Phone Number: <code>(0\d{1,4}-|\(0\d{1,4}\) ?)?\d{1,4}-\d{4}</code></li>
		<li>Japanese Postal Code: <code>\d{3}(-(\d{4}|\d{2}))?</code></li>
		<li>P.R.C. Phone Number: <code>(\(\d{3}\)|\d{3}-)?\d{8} </code></li>
		<li>P.R.C. Postal Code: <code>\d{6}</code></li>
		<li>P.R.C. Social Security Number: <code>\d{18}|\d{15}</code></li>
		<li>U.S. Phone Number: <code>((\(\d{3}\) ?)|(\d{3}-))?\d{3}-\d{4}</code></li>
		<li>U.S. ZIP Code: <code>\d{5}(-\d{4})?</code></li>
		<li>U.S. Social Security Number: <code>\d{3}-\d{2}-\d{4}</code></li>
	</ul>
	More regular expression patterns can be found on the Internet, e.g.
	<a href="http://regexlib.com/">http://regexlib.com/</a>.
	</dd>
</dl>
<p>
Note, if the value being validated is empty, TRegularExpressionValidator will not do validation. Use a TRequiredFieldValidator to ensure the value is not empty.
</p>

<com:RunBar PagePath="Controls.Samples.TRegularExpressionValidator.Home" />

<h2>TEmailAddressValidator</h2>
<p><tt>TEmailAddressValidator</tt> validates whether the value of an associated input component is a valid email address. If <tt>CheckMXRecord</tt> is true, besides checking the format of the input value, the validator will also check MX record for the email address, provided <tt>checkdnsrr()</tt> is available in the installed PHP.
</p>
<p>
Note, if the value being validated is empty, TEmailAddressValidator will not do validation. Use a TRequiredFieldValidator to ensure the value is not empty.
</p>
<com:RunBar PagePath="Controls.Samples.TEmailAddressValidator.Home" />

<h2>TCompareValidator</h2>
<p>The validator <tt>TCompareValidator</tt> is used to compare two input fields, the comparison can be made in many ways. The following are the properties of the <tt>TCompareValidator</tt> in addition to the parent <tt>TBaseValidator</tt>.
</p>
<dl>
	<dt>ControlToCompare</dt>
	<dd>The input component to compare with the input control being validated. </dd>

	<dt>ValueToCompare</dt>
	<dd>A constant value to compare with the value entered by the user into the input component being validated. </dd>

	<dt>ValueType</dt>
	<dd>The data type (<tt>Integer</tt>, <tt>Double</tt>, <tt>Currency</tt>, <tt>Date</tt>, <tt>String</tt>) that the values being compared are converted to before the comparison is made. </dd>

	<dt>Operator</dt>
	<dd>The comparison operation to perform (<tt>Equal</tt>, <tt>NotEqual</tt>, <tt>GreaterThan</tt>, <tt>GreaterThanEqual</tt>, <tt>LessThan</tt>, <tt>LessThanEqual</tt>, <tt>DataTypeCheck</tt>). </dd>

	<dt>DateFormat</dt>
	<dd>The date format to use during comparision.</dd>
</dl>

<p>To specify the input component to validate, set the <tt>ControlToValidate</tt> property to the <tt>ID</tt> of the input component. To compare the associated input component with another input component, set the <tt>ControlToCompare</tt> property to the <tt>ID</tt> of the component to compare with. </p>

<p>To compare the associated input component with a constant value, specify the constant value to compare with by setting the <tt>ValueToCompare</tt> property. </p>

<p>The <tt>ValueType</tt> property is used to specify the data type of both comparison values. Both values are automatically converted to this data type before the comparison operation is performed. The following value types are supported. </p>
<dl>
	<dt>Integer</dt>
	<dd>A 32-bit signed integer data type. </dd>

	<dt>Float</dt>
	<dd>A double-precision floating point number data type. </dd>

	<dt>Currency</dt>
	<dd>A decimal data type that can contain currency symbols. </dd>

	<dt>Date</dt>
	<dd>A date data type, the date format depends on the <tt>DateFormat</tt> property.</dd>

	<dt>String</dt>
	<dd>A string data type.</dd>
</dl>

<p>Use the <tt>Operator</tt> property to specify the type of comparison to perform. If you set the <tt>Operator</tt> property to <tt>DataTypeCheck</tt>, the <tt>TCompareValidator</tt> component will ignore the <tt>ControlToCompare</tt> and <tt>ValueToCompare</tt> properties and simply indicates whether the value entered into the input component can be converted to the data type specified by the <tt>ValueType</tt> property. </p>

<p>Note that if the input control is empty, no validation functions are called and validation succeeds. Use a <tt>RequiredFieldValidator</tt> control to require the user to enter data into the input control. </p>
<com:RunBar PagePath="Controls.Samples.TCompareValidator.Home" />

<h2>TRangeValidator</h2>
<p>
TRangeValidator tests whether an input value is within a specified range.
</p>
<p>
TRangeValidator uses three key properties to perform its validation. The <tt>MinValue</tt> and <tt>MaxValue</tt> properties specify the minimum and maximum values of the valid range. The <tt>ValueType</tt> property specifies the data type of the value being validated. The value will be first converted into the specified type and then compare with the valid range. The following value types are supported:
</p>
<ul>
<li><tt>String</tt> - A string data type.</li>
<li><tt>Integer</tt> - A 32-bit signed integer data type.</li>
<li><tt>Float</tt> - A double-precision floating point number data type.</li>
<li><tt>Currency</tt> - A decimal data type that can contain currency symbols.</li>
<li><tt>Date</tt> - A date data type. The date format can be specified by setting <tt>DateFormat</tt> property, which must be recognizable by <tt>TSimpleDateFormatter</tt>. If the property is not set, the GNU date syntax is assumed.</li>
</ul>
<com:RunBar PagePath="Controls.Samples.TRangeValidator.Home" />

<h2>TDataTypeValidator</h2>
<p>
</p>
<com:RunBar PagePath="Controls.Samples.TDataTypeValidator.Home" />

<h2>TCustomValidator</h2>
<p>
TCustomValidator performs user-defined validation (either server-side or client-side or both) on an input control.
</p>
<p>
To create a server-side validation function, provide a handler for the <tt>OnServerValidate</tt> event that performs the validation. The data string of the input control to validate can be accessed by the event parameter's <tt>Value</tt> property. The result of the validation should be stored in the <tt>IsValid</tt> property of the parameter.
</p>
<p>
To create a client-side validation function, add the client-side validation javascript function to the page template and assign its name to the <tt>ClientValidationFunction</tt> property. The function should have the following signature:
</p>
<com:TTextHighlighter Language="javascript" CssClass="source">
<script type="text/javascript">
function ValidationFunctionName(sender, parameter)
{
    // if(parameter == ...)
    //    return true;
    // else
    //    return false;
}
</script>
</com:TTextHighlighter>
<com:RunBar PagePath="Controls.Samples.TCustomValidator.Home" />


<h2>TValidationSummary</h2>
<p>
</p>
<com:RunBar PagePath="Controls.Samples.TValidationSummary.Home" />

</com:TContent>