-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
RequiredFieldValidator.xml
244 lines (212 loc) · 17.4 KB
/
RequiredFieldValidator.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
<Type Name="RequiredFieldValidator" FullName="System.Web.UI.WebControls.RequiredFieldValidator">
<TypeSignature Language="C#" Value="public class RequiredFieldValidator : System.Web.UI.WebControls.BaseValidator" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RequiredFieldValidator extends System.Web.UI.WebControls.BaseValidator" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.RequiredFieldValidator" />
<TypeSignature Language="VB.NET" Value="Public Class RequiredFieldValidator
Inherits BaseValidator" />
<TypeSignature Language="F#" Value="type RequiredFieldValidator = class
 inherit BaseValidator" />
<TypeSignature Language="C++ CLI" Value="public ref class RequiredFieldValidator : System::Web::UI::WebControls::BaseValidator" />
<AssemblyInfo>
<AssemblyName>System.Web</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.WebControls.BaseValidator</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="netframework-1.1">
<AttributeName Language="C#">[System.Web.UI.ToolboxData("<{0}:RequiredFieldValidator runat=server ErrorMessage="RequiredFieldValidator"></{0}:RequiredFieldValidator>")]</AttributeName>
<AttributeName Language="F#">[<System.Web.UI.ToolboxData("<{0}:RequiredFieldValidator runat=server ErrorMessage="RequiredFieldValidator"></{0}:RequiredFieldValidator>")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;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.Web.UI.ToolboxData("<{0}:RequiredFieldValidator runat="server" ErrorMessage="RequiredFieldValidator"></{0}:RequiredFieldValidator>")]</AttributeName>
<AttributeName Language="F#">[<System.Web.UI.ToolboxData("<{0}:RequiredFieldValidator runat="server" ErrorMessage="RequiredFieldValidator"></{0}:RequiredFieldValidator>")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Makes the associated input control a required field.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this control to make an input control a required field. The input control fails validation if its value does not change from the <xref:System.Web.UI.WebControls.RequiredFieldValidator.InitialValue%2A> property upon losing focus.
Multiple validators can be associated with the same input control. For example, a <xref:System.Web.UI.WebControls.RequiredFieldValidator> can be used to ensure input to a control, while at the same time a <xref:System.Web.UI.WebControls.RangeValidator> can be used to ensure that the input is within a specified data range.
> [!NOTE]
> When you use the <xref:System.Web.UI.WebControls.RequiredFieldValidator> control inside an <xref:System.Web.UI.UpdatePanel> control, make sure that the validator control and the control it is associated with are in the same panel. For more information about using the <xref:System.Web.UI.UpdatePanel> control for partial-page updates, see [Partial-Page Rendering Overview](https://learn.microsoft.com/previous-versions/aspnet/bb386573(v=vs.100)).
For additional information on validation controls, see <xref:System.Web.UI.WebControls.BaseValidator>.
## Accessibility
For information about how to configure this control so that it generates markup that conforms to accessibility standards, see [Accessibility in Visual Studio and ASP.NET](https://learn.microsoft.com/previous-versions/ms228004(v=vs.140)) and [ASP.NET Controls and Accessibility](https://learn.microsoft.com/previous-versions/ms227996(v=vs.140)).
## Examples
The following example demonstrates how to use the <xref:System.Web.UI.WebControls.RequiredFieldValidator> control to make sure that the user enters a value into the text box.
> [!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/Classic RequiredFieldValidator Example/CS/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic RequiredFieldValidator Example/VB/sourcevb.aspx" id="Snippet1":::
:::code language="xml" source="~/snippets/common/VS_Snippets_WebNet/Classic RequiredFieldValidator Example/Common/source.xml" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.RangeValidator" />
<altmember cref="P:System.Web.UI.WebControls.RequiredFieldValidator.InitialValue" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RequiredFieldValidator ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.RequiredFieldValidator.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 RequiredFieldValidator();" />
<MemberType>Constructor</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>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of <see cref="T:System.Web.UI.WebControls.RequiredFieldValidator" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this constructor to create and initialize a new instance of the <xref:System.Web.UI.WebControls.RequiredFieldValidator> class.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.RangeValidator" />
<altmember cref="P:System.Web.UI.WebControls.RequiredFieldValidator.InitialValue" />
</Docs>
</Member>
<Member MemberName="AddAttributesToRender">
<MemberSignature Language="C#" Value="protected override void AddAttributesToRender (System.Web.UI.HtmlTextWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void AddAttributesToRender(class System.Web.UI.HtmlTextWriter writer) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.RequiredFieldValidator.AddAttributesToRender(System.Web.UI.HtmlTextWriter)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub AddAttributesToRender (writer As HtmlTextWriter)" />
<MemberSignature Language="F#" Value="override this.AddAttributesToRender : System.Web.UI.HtmlTextWriter -> unit" Usage="requiredFieldValidator.AddAttributesToRender writer" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void AddAttributesToRender(System::Web::UI::HtmlTextWriter ^ writer);" />
<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>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<param name="writer">A <see cref="T:System.Web.UI.HtmlTextWriter" /> that represents the output stream to render HTML content on the client.</param>
<summary>Adds the HTML attributes and styles that need to be rendered for the control to the specified <see cref="T:System.Web.UI.HtmlTextWriter" /> object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates how to override the <xref:System.Web.UI.WebControls.RequiredFieldValidator.AddAttributesToRender%2A> method in a custom server control so that the <xref:System.Web.UI.WebControls.RequiredFieldValidator> error message always displays as bold.
> [!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/CustomRequiredFieldValidatorAddAttributesToRender/CS/custom_requiredfieldvalidator_addattributestorendercs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomRequiredFieldValidatorAddAttributesToRender/VB/custom_requiredfieldvalidator_addattributestorendervb.aspx" id="Snippet1":::
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomRequiredFieldValidatorAddAttributesToRender/CS/custom_requiredfieldvalidator_addattributestorender.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomRequiredFieldValidatorAddAttributesToRender/VB/custom_requiredfieldvalidator_addattributestorender.vb" id="Snippet2":::
]]></format>
</remarks>
</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.WebControls.RequiredFieldValidator.EvaluateIsValid" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function EvaluateIsValid () As Boolean" />
<MemberSignature Language="F#" Value="override this.EvaluateIsValid : unit -> bool" Usage="requiredFieldValidator.EvaluateIsValid " />
<MemberSignature Language="C++ CLI" Value="protected:
 override bool EvaluateIsValid();" />
<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.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Called during the validation stage when ASP.NET processes a Web Form.</summary>
<returns>
<see langword="true" /> if the value in the input control is valid; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates how to override the <xref:System.Web.UI.WebControls.RequiredFieldValidator.EvaluateIsValid%2A> method in a custom server control so that it always returns `false` if the value of the <xref:System.Web.UI.WebControls.RequiredFieldValidator> is null or empty, and always returns `true` otherwise.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomRequiredFieldValidatorEvaluateIsValid/CS/custom_requiredfieldvalidator_evaluateisvalidcs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomRequiredFieldValidatorEvaluateIsValid/VB/custom_requiredfieldvalidator_evaluateisvalidvb.aspx" id="Snippet1":::
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomRequiredFieldValidatorEvaluateIsValid/CS/custom_requiredfieldvalidator_evaluateisvalid.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomRequiredFieldValidatorEvaluateIsValid/VB/custom_requiredfieldvalidator_evaluateisvalid.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="InitialValue">
<MemberSignature Language="C#" Value="public string InitialValue { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string InitialValue" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.RequiredFieldValidator.InitialValue" />
<MemberSignature Language="VB.NET" Value="Public Property InitialValue As String" />
<MemberSignature Language="F#" Value="member this.InitialValue : string with get, set" Usage="System.Web.UI.WebControls.RequiredFieldValidator.InitialValue" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ InitialValue { 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>
<Attributes>
<Attribute FrameworkAlternate="netframework-1.1">
<AttributeName Language="C#">[System.ComponentModel.Bindable(true)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Bindable(true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue("")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue("")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;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.Web.UI.Themeable(false)]</AttributeName>
<AttributeName Language="F#">[<System.Web.UI.Themeable(false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the initial value of the associated input control.</summary>
<value>A string that specifies the initial value of the associated input control. The default is <see cref="F:System.String.Empty" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this property to specify the initial value of the input control.
Validation fails only if the value of the associated input control matches this <xref:System.Web.UI.WebControls.RequiredFieldValidator.InitialValue%2A> upon losing focus.
> [!NOTE]
> The strings in both the <xref:System.Web.UI.WebControls.RequiredFieldValidator.InitialValue%2A> property and the input control are trimmed to remove extra spaces before and after the string before validation is performed.
This property cannot be set by themes or style sheet themes. For more information, see <xref:System.Web.UI.ThemeableAttribute> and [ASP.NET Themes and Skins](https://learn.microsoft.com/previous-versions/aspnet/ykzx33wh(v=vs.100)).
## Examples
The following example demonstrates how to use the <xref:System.Web.UI.WebControls.RequiredFieldValidator.InitialValue%2A> property to ensure that the user enters a value in the text box.
> [!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/Classic RequiredFieldValidator.InitialValue Example/CS/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic RequiredFieldValidator.InitialValue Example/VB/sourcevb.aspx" id="Snippet1":::
The following example demonstrates how to use the <xref:System.Web.UI.WebControls.RequiredFieldValidator.InitialValue%2A> property to ensure that the user selects an item from the list box.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic RequiredFieldValidator.InitialValue Example/CS/source2cs.aspx" id="Snippet2":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic RequiredFieldValidator.InitialValue Example/VB/source2vb.aspx" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>