-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
IValidator.xml
167 lines (143 loc) · 10 KB
/
IValidator.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
<Type Name="IValidator" FullName="System.Web.UI.IValidator">
<TypeSignature Language="C#" Value="public interface IValidator" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IValidator" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.IValidator" />
<TypeSignature Language="VB.NET" Value="Public Interface IValidator" />
<TypeSignature Language="F#" Value="type IValidator = interface" />
<TypeSignature Language="C++ CLI" Value="public interface class IValidator" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>Defines the properties and methods that objects that participate in Web Forms validation must implement.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Classes that implement this interface represent a possible user input error. When the <xref:System.Web.UI.IValidator.Validate%2A> method is called, the class updates its <xref:System.Web.UI.IValidator.IsValid%2A> property to signify whether the error occurred. The <xref:System.Web.UI.IValidator.ErrorMessage%2A> property contains a text description of the error condition that you can display when the error occurs.
The <xref:System.Web.UI.WebControls.BaseValidator> class implements this interface, and all other ASP.NET validation server control classes inherit from <xref:System.Web.UI.WebControls.BaseValidator>. For information on validation server controls and how they work, see [ASP.NET Validation Controls](https://learn.microsoft.com/previous-versions/aspnet/debza5t0(v=vs.100)).
For details on how to develop custom ASP.NET validation server controls, see [How to: Validate with a Custom Function for ASP.NET Server Controls](https://msdn.microsoft.com/library/f3ece2ad-2e88-40df-bb8b-3fe53ecf21ab).
## Examples
> [!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/IValidator_IsValid_ReSubmit/CS/ivalidator_isvalid.cs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/IValidator_IsValid_ReSubmit/VB/ivalidator_isvalid.vb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.ValidatorCollection" />
<altmember cref="P:System.Web.UI.Page.Validators" />
<altmember cref="T:System.Web.UI.WebControls.BaseValidator" />
<altmember cref="T:System.Web.UI.WebControls.BaseCompareValidator" />
<altmember cref="T:System.Web.UI.WebControls.CompareValidator" />
<altmember cref="T:System.Web.UI.WebControls.CustomValidator" />
<altmember cref="T:System.Web.UI.WebControls.RangeValidator" />
<altmember cref="T:System.Web.UI.WebControls.RegularExpressionValidator" />
<altmember cref="T:System.Web.UI.WebControls.RequiredFieldValidator" />
<related type="Article" href="https://msdn.microsoft.com/library/f3ece2ad-2e88-40df-bb8b-3fe53ecf21ab">How to: Validate with a Custom Function for ASP.NET Server Controls</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/debza5t0(v=vs.100)">Validation ASP.NET Controls</related>
</Docs>
<Members>
<Member MemberName="ErrorMessage">
<MemberSignature Language="C#" Value="public string ErrorMessage { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ErrorMessage" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.IValidator.ErrorMessage" />
<MemberSignature Language="VB.NET" Value="Public Property ErrorMessage As String" />
<MemberSignature Language="F#" Value="member this.ErrorMessage : string with get, set" Usage="System.Web.UI.IValidator.ErrorMessage" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ErrorMessage { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>When implemented by a class, gets or sets the error message text generated when the condition being validated fails.</summary>
<value>The error message to generate.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
ASP.NET developers access this property declaratively in the opening tag of a validation server control. For more information, see [Validation Server Control Syntax](https://msdn.microsoft.com/library/96d2c59e-693c-4079-9b53-b3ff0d9e9133).
## Examples
> [!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/IValidator_IsValid_ReSubmit/CS/ivalidator_isvalid.cs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/IValidator_IsValid_ReSubmit/VB/ivalidator_isvalid.vb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.BaseValidator" />
</Docs>
</Member>
<Member MemberName="IsValid">
<MemberSignature Language="C#" Value="public bool IsValid { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsValid" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.IValidator.IsValid" />
<MemberSignature Language="VB.NET" Value="Public Property IsValid As Boolean" />
<MemberSignature Language="F#" Value="member this.IsValid : bool with get, set" Usage="System.Web.UI.IValidator.IsValid" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsValid { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</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>
<Docs>
<summary>When implemented by a class, gets or sets a value indicating whether the user-entered content in the specified control passes validation.</summary>
<value>
<see langword="true" /> if the content is valid; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
> [!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/IValidator_IsValid_ReSubmit/CS/ivalidator_isvalid.cs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/IValidator_IsValid_ReSubmit/VB/ivalidator_isvalid.vb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.BaseValidator" />
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.IValidator.Validate" />
<MemberSignature Language="VB.NET" Value="Public Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit" Usage="iValidator.Validate " />
<MemberSignature Language="C++ CLI" Value="public:
 void Validate();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>When implemented by a class, evaluates the condition it checks and updates the <see cref="P:System.Web.UI.IValidator.IsValid" /> property.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
> [!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/IValidator_IsValid_ReSubmit/CS/ivalidator_isvalid.cs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/IValidator_IsValid_ReSubmit/VB/ivalidator_isvalid.vb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.BaseValidator" />
</Docs>
</Member>
</Members>
</Type>