Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

RegularExpressionAttribute Class

Specifies that a data field value in ASP.NET Dynamic Data must match the specified regular expression.

System.Object
  System.Attribute
    System.ComponentModel.DataAnnotations.ValidationAttribute
      System.ComponentModel.DataAnnotations.RegularExpressionAttribute

Namespace:  System.ComponentModel.DataAnnotations
Assemblies:   System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)
  System.ComponentModel.Annotations (in System.ComponentModel.Annotations.dll)

[<AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter, AllowMultiple = false)>]
type RegularExpressionAttribute =  
    class 
        inherit ValidationAttribute 
    end

The RegularExpressionAttribute type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibraryRegularExpressionAttributeInitializes a new instance of the RegularExpressionAttribute class.
Top

  NameDescription
Public propertySupported by Portable Class LibraryErrorMessageGets or sets an error message to associate with a validation control if validation fails. (Inherited from ValidationAttribute.)
Public propertySupported by Portable Class LibraryErrorMessageResourceNameGets or sets the error message resource name to use in order to look up the ErrorMessageResourceType property value if validation fails. (Inherited from ValidationAttribute.)
Public propertySupported by Portable Class LibraryErrorMessageResourceTypeGets or sets the resource type to use for error-message lookup if validation fails. (Inherited from ValidationAttribute.)
Protected propertySupported by Portable Class LibraryErrorMessageStringGets the localized validation error message. (Inherited from ValidationAttribute.)
Public propertySupported by Portable Class LibraryPatternGets the regular expression pattern.
Public propertyRequiresValidationContextGets a value that indicates whether the attribute requires validation context. (Inherited from ValidationAttribute.)
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodSupported by Portable Class LibraryEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Portable Class LibraryFormatErrorMessageFormats the error message to display if the regular expression validation fails. (Overrides ValidationAttribute.FormatErrorMessage(String).)
Public methodSupported by Portable Class LibraryGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetValidationResultChecks whether the specified value is valid with respect to the current validation attribute. (Inherited from ValidationAttribute.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodIsValid(Object)Checks whether the value entered by the user matches the regular expression pattern. (Overrides ValidationAttribute.IsValid(Object).)
Protected methodSupported by Portable Class LibraryIsValid(Object, ValidationContext)Validates the specified value with respect to the current validation attribute. (Inherited from ValidationAttribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryValidate(Object, ValidationContext)Validates the specified object. (Inherited from ValidationAttribute.)
Public methodValidate(Object, String)Validates the specified object. (Inherited from ValidationAttribute.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

You apply the RegularExpressionAttribute attribute to a property when you need to validate values for the property against a regular expression. The regular expression enables you to specify very precisely the format of valid values. The Pattern property contains the regular expression.If the value of the property is null or an empty string (""), the value automatically passes validation for the RegularExpressionAttribute attribute. To validate that the value is not a null reference (Nothing in Visual Basic) or an empty string, use the RequiredAttribute attribute.

The following example shows how to use the RegularExpressionAttribute attribute to validate the FirstName and LastName data fields. The regular expression allows up to 40 uppercase and lowercase characters. The example performs the following tasks:

  • Implements a metadata partial class and the associated metadata class.

  • In the associated metadata class, applies the RegularExpressionAttribute attribute to the FirstName and LastName data fields, specifying the pattern and custom error messages.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2015 Microsoft