-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
CustomValidator.xml
248 lines (233 loc) · 18.5 KB
/
CustomValidator.xml
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<Type Name="CustomValidator" FullName="System.Web.UI.MobileControls.CustomValidator">
<TypeSignature Language="C#" Value="public class CustomValidator : System.Web.UI.MobileControls.BaseValidator" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CustomValidator extends System.Web.UI.MobileControls.BaseValidator" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.MobileControls.CustomValidator" />
<TypeSignature Language="VB.NET" Value="Public Class CustomValidator
Inherits BaseValidator" />
<TypeSignature Language="F#" Value="type CustomValidator = class
 inherit BaseValidator" />
<TypeSignature Language="C++ CLI" Value="public ref class CustomValidator : System::Web::UI::MobileControls::BaseValidator" />
<AssemblyInfo>
<AssemblyName>System.Web.Mobile</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.MobileControls.BaseValidator</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultEvent("ServerValidate")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultEvent("ServerValidate")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-1.1">
<AttributeName Language="C#">[System.ComponentModel.ToolboxItem("System.Web.UI.Design.WebControlToolboxItem, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.ToolboxItem("System.Web.UI.Design.WebControlToolboxItem, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Web.UI.ToolboxData("<{0}:CustomValidator runat="server" ErrorMessage="CustomValidator"></{0}:CustomValidator>")]</AttributeName>
<AttributeName Language="F#">[<System.Web.UI.ToolboxData("<{0}:CustomValidator runat="server" ErrorMessage="CustomValidator"></{0}:CustomValidator>")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5">
<AttributeName Language="C#">[System.ComponentModel.ToolboxItem("System.Web.UI.Design.WebControlToolboxItem, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.ToolboxItem("System.Web.UI.Design.WebControlToolboxItem, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.ComponentModel.ToolboxItem("System.Web.UI.Design.WebControlToolboxItem, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.ToolboxItem("System.Web.UI.Design.WebControlToolboxItem, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Obsolete("The System.Web.Mobile.dll assembly has been deprecated and should no longer be used. For information about how to develop ASP.NET mobile applications, see http://go.microsoft.com/fwlink/?LinkId=157231.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("The System.Web.Mobile.dll assembly has been deprecated and should no longer be used. For information about how to develop ASP.NET mobile applications, see http://go.microsoft.com/fwlink/?LinkId=157231.")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Provides a control that can perform custom validation against another control. For information about how to develop ASP.NET mobile applications, see <see href="https://learn.microsoft.com/aspnet/mobile/overview">Mobile Apps & Sites with ASP.NET</see>.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class behaves identically to the <xref:System.Web.UI.WebControls.CustomValidator?displayProperty=nameWithType> Web server control. Developers can choose their own common language runtime delegate to use for validation.
By default, <xref:System.Web.UI.MobileControls.Command> controls on a form raise validator events on the form to perform validation when the form is submitted to the server. To disable automatic validation, set the <xref:System.Web.UI.MobileControls.Command.CausesValidation%2A> property on the <xref:System.Web.UI.MobileControls.Command> controls to `false`.
## Examples
The following example checks whether the value that a user places into the <xref:System.Web.UI.MobileControls.TextBox> control is an even number. If the value is an even number, then the page is valid. If not, the page is not valid, and the <xref:System.Web.UI.MobileControls.CustomValidator> displays the <xref:System.Web.UI.MobileControls.BaseValidator.ErrorMessage%2A> property.
> [!NOTE]
> The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see [ASP.NET Web Forms Page Code Model](https://learn.microsoft.com/previous-versions/aspnet/015103yb(v=vs.100)).
> [!IMPORTANT]
> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)).
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/MobileCustomValidatorSample/cs/Default.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/MobileCustomValidatorSample/vb/Default.aspx" id="Snippet1":::
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-3.0/0b130ft3(v=vs.85)">Introduction to the CustomValidator Control</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-3.0/w2e9k2tc(v=vs.85)">Adding and Configuring a CustomValidator Control</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CustomValidator ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.MobileControls.CustomValidator.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 CustomValidator();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Mobile</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.MobileControls.CustomValidator" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ControlPropertiesValid">
<MemberSignature Language="C#" Value="protected override bool ControlPropertiesValid ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance bool ControlPropertiesValid() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.MobileControls.CustomValidator.ControlPropertiesValid" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function ControlPropertiesValid () As Boolean" />
<MemberSignature Language="F#" Value="override this.ControlPropertiesValid : unit -> bool" Usage="customValidator.ControlPropertiesValid " />
<MemberSignature Language="C++ CLI" Value="protected:
 override bool ControlPropertiesValid();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Mobile</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Determines whether the properties to be validated are valid. This API is obsolete. For information about how to develop ASP.NET mobile applications, see <see href="https://learn.microsoft.com/aspnet/mobile/overview">Mobile Apps & Sites with ASP.NET</see>.</summary>
<returns>
<see langword="true" /> if control properties to be validated are valid; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Web.UI.MobileControls.BaseValidator.ControlPropertiesValid" />
</Docs>
</Member>
<Member MemberName="CreateWebValidator">
<MemberSignature Language="C#" Value="protected override System.Web.UI.WebControls.BaseValidator CreateWebValidator ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.Web.UI.WebControls.BaseValidator CreateWebValidator() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.MobileControls.CustomValidator.CreateWebValidator" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function CreateWebValidator () As BaseValidator" />
<MemberSignature Language="F#" Value="override this.CreateWebValidator : unit -> System.Web.UI.WebControls.BaseValidator" Usage="customValidator.CreateWebValidator " />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::Web::UI::WebControls::BaseValidator ^ CreateWebValidator();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Mobile</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.BaseValidator</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Virtual method for derived class to create its own aggregated Web validator. The Web validator is for getting and setting of the common properties of Web base validator. This API is obsolete. For information about how to develop ASP.NET mobile applications, see <see href="https://learn.microsoft.com/aspnet/mobile/overview">Mobile Apps & Sites with ASP.NET</see>.</summary>
<returns>An aggregated Web validator.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Web.UI.MobileControls.BaseValidator.CreateWebValidator" />
</Docs>
</Member>
<Member MemberName="EvaluateIsValid">
<MemberSignature Language="C#" Value="protected override bool EvaluateIsValid ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance bool EvaluateIsValid() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.MobileControls.CustomValidator.EvaluateIsValid" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function EvaluateIsValid () As Boolean" />
<MemberSignature Language="F#" Value="override this.EvaluateIsValid : unit -> bool" Usage="customValidator.EvaluateIsValid " />
<MemberSignature Language="C++ CLI" Value="protected:
 override bool EvaluateIsValid();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Mobile</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Called during the validation stage when ASP.NET processes a Mobile Web Form. This API is obsolete. For information about how to develop ASP.NET mobile applications, see <see href="https://learn.microsoft.com/aspnet/mobile/overview">Mobile Apps & Sites with ASP.NET</see>.</summary>
<returns>
<see langword="true" /> if the validator is valid, otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Web.UI.MobileControls.BaseValidator.EvaluateIsValid" />
</Docs>
</Member>
<Member MemberName="OnServerValidate">
<MemberSignature Language="C#" Value="protected virtual bool OnServerValidate (string value);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool OnServerValidate(string value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.MobileControls.CustomValidator.OnServerValidate(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function OnServerValidate (value As String) As Boolean" />
<MemberSignature Language="F#" Value="abstract member OnServerValidate : string -> bool
override this.OnServerValidate : string -> bool" Usage="customValidator.OnServerValidate value" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual bool OnServerValidate(System::String ^ value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Mobile</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="value">The value to validate.</param>
<summary>Raises the <see cref="E:System.Web.UI.MobileControls.CustomValidator.ServerValidate" /> event.</summary>
<returns>
<see langword="true" /> if the value specified by the <paramref name="value" /> parameter passes validation; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ServerValidate">
<MemberSignature Language="C#" Value="public event System.Web.UI.WebControls.ServerValidateEventHandler ServerValidate;" />
<MemberSignature Language="ILAsm" Value=".event class System.Web.UI.WebControls.ServerValidateEventHandler ServerValidate" />
<MemberSignature Language="DocId" Value="E:System.Web.UI.MobileControls.CustomValidator.ServerValidate" />
<MemberSignature Language="VB.NET" Value="Public Custom Event ServerValidate As ServerValidateEventHandler " />
<MemberSignature Language="F#" Value="member this.ServerValidate : System.Web.UI.WebControls.ServerValidateEventHandler " Usage="member this.ServerValidate : System.Web.UI.WebControls.ServerValidateEventHandler " />
<MemberSignature Language="C++ CLI" Value="public:
 event System::Web::UI::WebControls::ServerValidateEventHandler ^ ServerValidate;" />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Mobile</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Bindable(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Bindable(false)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.ServerValidateEventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the <see cref="T:System.Web.UI.MobileControls.CustomValidator" /> validates the value of the <see cref="P:System.Web.UI.MobileControls.BaseValidator.ControlToValidate" /> property. This API is obsolete. For information about how to develop ASP.NET mobile applications, see <see href="https://learn.microsoft.com/aspnet/mobile/overview">Mobile Apps & Sites with ASP.NET</see>.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If a method is registered with this event, it is called with the value of the <xref:System.Web.UI.MobileControls.BaseValidator.ControlToValidate%2A> property. Validation succeeds only if this event handler returns `true`.
## Examples
The following example demonstrates how to trap the <xref:System.Web.UI.MobileControls.CustomValidator.ServerValidate> event to add logic to validate the page.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/MobileCustomValidatorSample/cs/Default.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/MobileCustomValidatorSample/vb/Default.aspx" id="Snippet1":::
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-3.0/0b130ft3(v=vs.85)">Introduction to the CustomValidator Control</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-3.0/w2e9k2tc(v=vs.85)">Adding and Configuring a CustomValidator Control</related>
</Docs>
</Member>
</Members>
</Type>