StringValidatorAttribute Class (System.Configuration)

.NET Framework Class Library

StringValidatorAttribute Class

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

Namespace: System.Configuration
Assembly: System.Configuration (in System.Configuration.dll)

Syntax

Visual Basic (Declaration)

<AttributeUsageAttribute(AttributeTargets.Property)> _
Public NotInheritable Class StringValidatorAttribute _
    Inherits ConfigurationValidatorAttribute

Visual Basic (Usage)

Dim instance As StringValidatorAttribute

[AttributeUsageAttribute(AttributeTargets.Property)]
public sealed class StringValidatorAttribute : ConfigurationValidatorAttribute

Visual C++

[AttributeUsageAttribute(AttributeTargets::Property)]
public ref class StringValidatorAttribute sealed : public ConfigurationValidatorAttribute

JScript

public final class StringValidatorAttribute extends ConfigurationValidatorAttribute

Remarks

You use the StringValidatorAttribute to decorate a configuration property. This is to instruct the .NET Framework to validate the property using the StringValidator and pass to it the value of the decorating parameters.

You can apply StringValidatorAttribute objects to property types only.

Examples

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

Visual Basic

<ConfigurationProperty("fileName", _
DefaultValue:="default.txt", _
IsRequired:=True, _
IsKey:=False), _
StringValidator( _
InvalidCharacters:=" ~!@#$%^&*()[]{}/;'""|\", _
MinLength:=1, _
MaxLength:=60)> _
Public Property FileName() As String
    Get
        Return CStr(Me("fileName"))
    End Get
    Set(ByVal value As String)
        Me("fileName") = value
    End Set
End Property

[ConfigurationProperty("fileName", DefaultValue = "default.txt",
    IsRequired = true, IsKey = false)]
[StringValidator(InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\",
    MinLength = 1, MaxLength = 60)]
public string FileName
{
    get
    {
        return (string)this["fileName"];
    }
    set
    {
        this["fileName"] = value;
    }
}

Inheritance Hierarchy

System..::.Object
  System..::.Attribute
    System.Configuration..::.ConfigurationValidatorAttribute
      System.Configuration..::.StringValidatorAttribute

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

StringValidatorAttribute Members

System.Configuration Namespace

ConfigurationValidatorAttribute

ConfigurationPropertyAttribute

StringValidator