RegularExpressionValidator Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Validates whether the value of an associated input control matches the pattern specified by a regular expression.
public ref class RegularExpressionValidator : System::Web::UI::WebControls::BaseValidator
public class RegularExpressionValidator : System.Web.UI.WebControls.BaseValidator
type RegularExpressionValidator = class
inherit BaseValidator
Public Class RegularExpressionValidator
Inherits BaseValidator
- Inheritance
Examples
The following example demonstrates how to use the RegularExpressionValidator control to validate a five-digit postal code.
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.
<%@ Page Language="C#" AutoEventWireup="True" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>RegularExpressionValidator Example</title>
<script runat="server">
void ValidateBtn_Click(Object sender, EventArgs e)
{
if (Page.IsValid)
{
lblOutput.Text = "Page is Valid.";
}
else
{
lblOutput.Text = "Page is InValid.";
}
}
</script>
</head>
<body>
<form id="form1" runat="server">
<h3>RegularExpressionValidator Example</h3>
<table style="background-color:#eeeeee; padding:10">
<tr valign="top">
<td colspan="3">
<asp:Label ID="lblOutput"
Text="Enter a 5-digit ZIP Code"
runat="server"
AssociatedControlID="TextBox1"/>
</td>
</tr>
<tr>
<td colspan="3">
<b>Personal Information</b>
</td>
</tr>
<tr>
<td align="right">
Zip Code:
</td>
<td>
<asp:TextBox id="TextBox1"
runat="server"/>
</td>
<td>
<asp:RegularExpressionValidator id="RegularExpressionValidator1"
ControlToValidate="TextBox1"
ValidationExpression="\d{5}"
Display="Static"
ErrorMessage="ZIP code must be 5 numeric digits"
EnableClientScript="False"
runat="server"/>
</td>
</tr>
<tr>
<td></td>
<td>
<asp:Button text="Validate"
OnClick="ValidateBtn_Click"
runat="server" />
</td>
<td></td>
</tr>
</table>
</form>
</body>
</html>
<%@ Page Language="VB" AutoEventWireup="True" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>RegularExpressionValidator Example</title>
<script runat="server">
Sub ValidateBtn_Click(sender As Object, e As EventArgs)
If Page.IsValid Then
lblOutput.Text = "Page is Valid."
Else
lblOutput.Text = "Page is InValid."
End If
End Sub
</script>
</head>
<body>
<h3>RegularExpressionValidator Example</h3>
<br />
<form id="form1" runat="server">
<table style="background-color:#eeeeee; padding:10">
<tr valign="top">
<td colspan="3">
<asp:Label ID="lblOutput"
Text="Enter a 5-digit ZIP Code"
runat="server"
AssociatedControlID="TextBox1"/>
</td>
</tr>
<tr>
<td colspan="3">
<b>Personal Information</b>
</td>
</tr>
<tr>
<td align="right">
Zip Code:
</td>
<td>
<asp:TextBox id="TextBox1"
runat="server"/>
</td>
<td>
<asp:RegularExpressionValidator id="RegularExpressionValidator1"
ControlToValidate="TextBox1"
ValidationExpression="\d{5}"
Display="Static"
ErrorMessage="Zip code must be 5 numeric digits"
EnableClientScript="False"
runat="server"/>
</td>
</tr>
<tr>
<td></td>
<td>
<asp:Button text="Validate"
OnClick="ValidateBtn_Click"
runat="server" />
</td>
<td></td>
</tr>
</table>
</form>
</body>
</html>
Remarks
The RegularExpressionValidator control checks whether the value of an input control matches a pattern defined by a regular expression. This type of validation allows you to check for predictable sequences of characters, such as those in email addresses, telephone numbers, and postal codes.
Note
Validation succeeds if the input control is empty. If a value is required for the associated input control, use a RequiredFieldValidator control in addition to the RegularExpressionValidator control.
Both server-side and client-side validation are performed unless the browser does not support client-side validation or client-side validation is explicitly disabled (by setting the EnableClientScript property to false
).
The regular-expression validation implementation is slightly different on the client than on the server. On the client, JScript regular-expression syntax is used. On the server, System.Text.RegularExpressions.Regex syntax is used. Since JScript regular expression syntax is a subset of System.Text.RegularExpressions.Regex syntax, it is recommended that JScript regular-expression syntax be used in order to yield the same results on both the client and the server.
Note
When you use the RegularExpressionValidator control inside an 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 UpdatePanel control for partial-page updates, see Partial-Page Rendering Overview.
For additional information about validation controls, see BaseValidator. For more information on regular expressions, see .NET Framework Regular Expressions.
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 and ASP.NET Controls and Accessibility.
Constructors
RegularExpressionValidator() |
Initializes a new instance of the RegularExpressionValidator class. |
Properties
AccessKey |
Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl) |
Adapter |
Gets the browser-specific adapter for the control. (Inherited from Control) |
AppRelativeTemplateSourceDirectory |
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control) |
AssociatedControlID |
This property is not supported. (Inherited from BaseValidator) |
Attributes |
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl) |
BackColor |
Gets or sets the background color of the Web server control. (Inherited from WebControl) |
BindingContainer |
Gets the control that contains this control's data binding. (Inherited from Control) |
BorderColor |
Gets or sets the border color of the Web control. (Inherited from WebControl) |
BorderStyle |
Gets or sets the border style of the Web server control. (Inherited from WebControl) |
BorderWidth |
Gets or sets the border width of the Web server control. (Inherited from WebControl) |
ChildControlsCreated |
Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control) |
ClientID |
Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control) |
ClientIDMode |
Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control) |
ClientIDSeparator |
Gets a character value representing the separator character used in the ClientID property. (Inherited from Control) |
Context |
Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control) |
Controls |
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control) |
ControlStyle |
Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl) |
ControlStyleCreated |
Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl) |
ControlToValidate |
Gets or sets the input control to validate. (Inherited from BaseValidator) |
CssClass |
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl) |
DataItemContainer |
Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control) |
DataKeysContainer |
Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control) |
DesignMode |
Gets a value indicating whether a control is being used on a design surface. (Inherited from Control) |
Display |
Gets or sets the display behavior of the error message in a validation control. (Inherited from BaseValidator) |
EnableClientScript |
Gets or sets a value indicating whether client-side validation is enabled. (Inherited from BaseValidator) |
Enabled |
Gets or sets a value that indicates whether the validation control is enabled. (Inherited from BaseValidator) |
EnableTheming |
Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl) |
EnableViewState |
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control) |
ErrorMessage |
Gets or sets the text for the error message displayed in a ValidationSummary control when validation fails. (Inherited from BaseValidator) |
Events |
Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control) |
Font |
Gets the font properties associated with the Web server control. (Inherited from WebControl) |
ForeColor |
Gets or sets the color of the message displayed when validation fails. (Inherited from BaseValidator) |
HasAttributes |
Gets a value indicating whether the control has attributes set. (Inherited from WebControl) |
HasChildViewState |
Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control) |
Height |
Gets or sets the height of the Web server control. (Inherited from WebControl) |
ID |
Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control) |
IdSeparator |
Gets the character used to separate control identifiers. (Inherited from Control) |
IsChildControlStateCleared |
Gets a value indicating whether controls contained within this control have control state. (Inherited from Control) |
IsEnabled |
Gets a value indicating whether the control is enabled. (Inherited from WebControl) |
IsTrackingViewState |
Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control) |
IsUnobtrusive |
Gets a value that indicates whether the control generates unobtrusive JavaScript. (Inherited from BaseValidator) |
IsValid |
Gets or sets a value that indicates whether the associated input control passes validation. (Inherited from BaseValidator) |
IsViewStateEnabled |
Gets a value indicating whether view state is enabled for this control. (Inherited from Control) |
LoadViewStateByID |
Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control) |
MatchTimeout |
Gets or set the maximum time interval to execute a single matching operation before the operation times out. |
NamingContainer |
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control) |
Page |
Gets a reference to the Page instance that contains the server control. (Inherited from Control) |
Parent |
Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control) |
PropertiesValid |
Gets a value that indicates whether the control specified by the ControlToValidate property is a valid control. (Inherited from BaseValidator) |
RenderingCompatibility |
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control) |
RenderUplevel |
Gets a value that indicates whether the client's browser supports "uplevel" rendering. (Inherited from BaseValidator) |
SetFocusOnError |
Gets or sets a value that indicates whether focus is set to the control specified by the ControlToValidate property when validation fails. (Inherited from BaseValidator) |
Site |
Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control) |
SkinID |
Gets or sets the skin to apply to the control. (Inherited from WebControl) |
Style |
Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl) |
SupportsDisabledAttribute |
Gets a value that indicates whether the control should set the |
TabIndex |
Gets or sets the tab index of the Web server control. (Inherited from WebControl) |
TagKey |
Gets the HTML tag that is used to render the Label control. (Inherited from Label) |
TagName |
Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl) |
TemplateControl |
Gets or sets a reference to the template that contains this control. (Inherited from Control) |
TemplateSourceDirectory |
Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control) |
Text |
Gets or sets the text displayed in the validation control when validation fails. (Inherited from BaseValidator) |
ToolTip |
Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl) |
UniqueID |
Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control) |
ValidateRequestMode |
Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control) |
ValidationExpression |
Gets or sets the regular expression that determines the pattern used to validate a field. |
ValidationGroup |
Gets or sets the name of the validation group to which this validation control belongs. (Inherited from BaseValidator) |
ViewState |
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control) |
ViewStateIgnoresCase |
Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control) |
ViewStateMode |
Gets or sets the view-state mode of this control. (Inherited from Control) |
Visible |
Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control) |
Width |
Gets or sets the width of the Web server control. (Inherited from WebControl) |
Methods
AddAttributesToRender(HtmlTextWriter) |
Adds to the specified HtmlTextWriter object the HTML attributes and styles that need to be rendered for the control. |
AddedControl(Control, Int32) |
Called after a child control is added to the Controls collection of the Control object. (Inherited from Control) |
AddParsedSubObject(Object) |
Notifies the control that an element was parsed and adds the element to the Label control. (Inherited from Label) |
ApplyStyle(Style) |
Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl) |
ApplyStyleSheetSkin(Page) |
Applies the style properties defined in the page style sheet to the control. (Inherited from Control) |
BeginRenderTracing(TextWriter, Object) |
Begins design-time tracing of rendering data. (Inherited from Control) |
BuildProfileTree(String, Boolean) |
Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control) |
CheckControlValidationProperty(String, String) |
Verifies whether the specified control is on the page and contains validation properties. (Inherited from BaseValidator) |
ClearCachedClientID() |
Sets the cached ClientID value to |
ClearChildControlState() |
Deletes the control-state information for the server control's child controls. (Inherited from Control) |
ClearChildState() |
Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control) |
ClearChildViewState() |
Deletes the view-state information for all the server control's child controls. (Inherited from Control) |
ClearEffectiveClientIDMode() |
Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control) |
ControlPropertiesValid() |
Determines whether the control specified by the ControlToValidate property is a valid control. (Inherited from BaseValidator) |
CopyBaseAttributes(WebControl) |
Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl) |
CreateChildControls() |
Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control) |
CreateControlCollection() |
Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control) |
CreateControlStyle() |
Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl) |
DataBind() |
Binds a data source to the invoked server control and all its child controls. (Inherited from Control) |
DataBind(Boolean) |
Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control) |
DataBindChildren() |
Binds a data source to the server control's child controls. (Inherited from Control) |
DetermineRenderUplevel() |
Determines whether the validation control can perform client-side validation. (Inherited from BaseValidator) |
Dispose() |
Enables a server control to perform final clean up before it is released from memory. (Inherited from Control) |
EndRenderTracing(TextWriter, Object) |
Ends design-time tracing of rendering data. (Inherited from Control) |
EnsureChildControls() |
Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control) |
EnsureID() |
Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control) |
Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
EvaluateIsValid() |
Indicates whether the value in the input control is valid. |
FindControl(String) |
Searches the current naming container for a server control with the specified |
FindControl(String, Int32) |
Searches the current naming container for a server control with the specified |
Focus() |
Sets input focus to a control. (Inherited from Control) |
GetControlRenderID(String) |
Gets the client ID of the specified control. (Inherited from BaseValidator) |
GetControlValidationValue(String) |
Gets the value associated with the specified input control. (Inherited from BaseValidator) |
GetDesignModeState() |
Gets design-time data for a control. (Inherited from Control) |
GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
GetRouteUrl(Object) |
Gets the URL that corresponds to a set of route parameters. (Inherited from Control) |
GetRouteUrl(RouteValueDictionary) |
Gets the URL that corresponds to a set of route parameters. (Inherited from Control) |
GetRouteUrl(String, Object) |
Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control) |
GetRouteUrl(String, RouteValueDictionary) |
Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control) |
GetType() |
Gets the Type of the current instance. (Inherited from Object) |
GetUniqueIDRelativeTo(Control) |
Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control) |
HasControls() |
Determines if the server control contains any child controls. (Inherited from Control) |
HasEvents() |
Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control) |
IsLiteralContent() |
Determines if the server control holds only literal content. (Inherited from Control) |
LoadControlState(Object) |
Restores control-state information from a previous page request that was saved by the SaveControlState() method. (Inherited from Control) |
LoadViewState(Object) |
Loads the previously saved state for the control. (Inherited from Label) |
MapPathSecure(String) |
Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control) |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
MergeStyle(Style) |
Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl) |
OnBubbleEvent(Object, EventArgs) |
Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control) |
OnDataBinding(EventArgs) |
Raises the DataBinding event. (Inherited from Control) |
OnInit(EventArgs) |
Raises the Init event. (Inherited from BaseValidator) |
OnLoad(EventArgs) |
Raises the Load event. (Inherited from Control) |
OnPreRender(EventArgs) |
Raises the PreRender event. (Inherited from BaseValidator) |
OnUnload(EventArgs) |
Raises the Unload event. (Inherited from BaseValidator) |
OpenFile(String) |
Gets a Stream used to read a file. (Inherited from Control) |
RaiseBubbleEvent(Object, EventArgs) |
Assigns any sources of the event and its information to the control's parent. (Inherited from Control) |
RegisterValidatorCommonScript() |
Registers code on the page for client-side validation. (Inherited from BaseValidator) |
RegisterValidatorDeclaration() |
Registers an ECMAScript array declaration using the array name |
RemovedControl(Control) |
Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control) |
Render(HtmlTextWriter) |
Displays the control on the client. (Inherited from BaseValidator) |
RenderBeginTag(HtmlTextWriter) |
Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl) |
RenderChildren(HtmlTextWriter) |
Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control) |
RenderContents(HtmlTextWriter) |
Renders the contents of the Label into the specified writer. (Inherited from Label) |
RenderControl(HtmlTextWriter) |
Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control) |
RenderControl(HtmlTextWriter, ControlAdapter) |
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control) |
RenderEndTag(HtmlTextWriter) |
Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl) |
ResolveAdapter() |
Gets the control adapter responsible for rendering the specified control. (Inherited from Control) |
ResolveClientUrl(String) |
Gets a URL that can be used by the browser. (Inherited from Control) |
ResolveUrl(String) |
Converts a URL into one that is usable on the requesting client. (Inherited from Control) |
SaveControlState() |
Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control) |
SaveViewState() |
Saves any state that was modified after the TrackViewState() method was invoked. (Inherited from WebControl) |
SetDesignModeState(IDictionary) |
Sets design-time data for a control. (Inherited from Control) |
SetRenderMethodDelegate(RenderMethod) |
Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control) |
SetTraceData(Object, Object) |
Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from Control) |
SetTraceData(Object, Object, Object) |
Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. (Inherited from Control) |
ToString() |
Returns a string that represents the current object. (Inherited from Object) |
TrackViewState() |
Causes the control to track changes to its view state so they can be stored in the object's ViewState property. (Inherited from WebControl) |
Validate() |
Performs validation on the associated input control and updates the IsValid property. (Inherited from BaseValidator) |
Events
DataBinding |
Occurs when the server control binds to a data source. (Inherited from Control) |
Disposed |
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control) |
Init |
Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control) |
Load |
Occurs when the server control is loaded into the Page object. (Inherited from Control) |
PreRender |
Occurs after the Control object is loaded but prior to rendering. (Inherited from Control) |
Unload |
Occurs when the server control is unloaded from memory. (Inherited from Control) |
Explicit Interface Implementations
IAttributeAccessor.GetAttribute(String) |
Gets an attribute of the Web control with the specified name. (Inherited from WebControl) |
IAttributeAccessor.SetAttribute(String, String) |
Sets an attribute of the Web control to the specified name and value. (Inherited from WebControl) |
IControlBuilderAccessor.ControlBuilder |
For a description of this member, see ControlBuilder. (Inherited from Control) |
IControlDesignerAccessor.GetDesignModeState() |
For a description of this member, see GetDesignModeState(). (Inherited from Control) |
IControlDesignerAccessor.SetDesignModeState(IDictionary) |
For a description of this member, see SetDesignModeState(IDictionary). (Inherited from Control) |
IControlDesignerAccessor.SetOwnerControl(Control) |
For a description of this member, see SetOwnerControl(Control). (Inherited from Control) |
IControlDesignerAccessor.UserData |
For a description of this member, see UserData. (Inherited from Control) |
IDataBindingsAccessor.DataBindings |
For a description of this member, see DataBindings. (Inherited from Control) |
IDataBindingsAccessor.HasDataBindings |
For a description of this member, see HasDataBindings. (Inherited from Control) |
IExpressionsAccessor.Expressions |
For a description of this member, see Expressions. (Inherited from Control) |
IExpressionsAccessor.HasExpressions |
For a description of this member, see HasExpressions. (Inherited from Control) |
IParserAccessor.AddParsedSubObject(Object) |
For a description of this member, see AddParsedSubObject(Object). (Inherited from Control) |
Extension Methods
FindDataSourceControl(Control) |
Returns the data source that is associated with the data control for the specified control. |
FindFieldTemplate(Control, String) |
Returns the field template for the specified column in the specified control's naming container. |
FindMetaTable(Control) |
Returns the metatable object for the containing data control. |