RegexStringValidatorAttribute Class (System.Configuration)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
RegexStringValidatorAttribute Class

Declaratively instructs the .NET Framework to perform string validation on a configuration property using a regular expression. This class cannot be inherited.

Inheritance Hierarchy
System.Object
  System.Attribute
    System.Configuration.ConfigurationValidatorAttribute
      System.Configuration.RegexStringValidatorAttribute

Namespace:  System.Configuration
Assembly:  System.Configuration (in System.Configuration.dll)
Syntax
Visual Basic
<AttributeUsageAttribute(AttributeTargets.Property)> _
Public NotInheritable Class RegexStringValidatorAttribute _
	Inherits ConfigurationValidatorAttribute
C#
[AttributeUsageAttribute(AttributeTargets.Property)]
public sealed class RegexStringValidatorAttribute : ConfigurationValidatorAttribute
Visual C++
[AttributeUsageAttribute(AttributeTargets::Property)]
public ref class RegexStringValidatorAttribute sealed : public ConfigurationValidatorAttribute
F#
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Property)>]
type RegexStringValidatorAttribute =  
    class
        inherit ConfigurationValidatorAttribute
    end

The RegexStringValidatorAttribute type exposes the following members.

Constructors
  Name Description
Public method RegexStringValidatorAttribute Initializes a new instance of the RegexStringValidatorAttribute object.
Top
Properties
  Name Description
Public property Regex Gets the string used to perform regular-expression validation.
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public property ValidatorInstance Gets an instance of the RegexStringValidator class. (Overrides ConfigurationValidatorAttribute.ValidatorInstance.)
Public property ValidatorType Gets the type of the validator attribute. (Inherited from ConfigurationValidatorAttribute.)
Top
Methods
  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

You use the RegexStringValidatorAttribute to decorate a configuration property, which will instruct the .NET Framework to validate the property using the RegexStringValidator and pass to it the value of the decorating parameters.

You may apply RegexStringValidatorAttribute objects to property types only.

Examples

The following example shows how to decorate the properties of a custom ConfigurationSection object using the RegexStringValidatorAttribute object.

Visual Basic

<ConfigurationProperty("alias2", _
DefaultValue:="alias.txt", _
IsRequired:=True, _
IsKey:=False), _
RegexStringValidator("\w+\S*")> _
Public Property Alias2() As String
    Get
        Return CStr(Me("alias2"))
    End Get
    Set(ByVal value As String)
        Me("alias2") = value
    End Set
End Property
C#

[ConfigurationProperty("alias2", DefaultValue = "alias.txt",
    IsRequired = true, IsKey = false)]
[RegexStringValidator(@"\w+\S*")]
public string Alias2
{
    get
    {
        return (string)this["alias2"];
    }
    set
    {
        this["alias2"] = value;
    }
}
Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System.Configuration Namespace
ConfigurationValidatorAttribute
ConfigurationPropertyAttribute
RegexStringValidator