StringValidatorAttribute Class

Definition

public ref class StringValidatorAttribute sealed : System::Configuration::ConfigurationValidatorAttribute

[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class StringValidatorAttribute : System.Configuration.ConfigurationValidatorAttribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type StringValidatorAttribute = class
    inherit ConfigurationValidatorAttribute

Public NotInheritable Class StringValidatorAttribute
Inherits ConfigurationValidatorAttribute

Inheritance

Object

Attribute

ConfigurationValidatorAttribute

StringValidatorAttribute

Attributes

AttributeUsageAttribute

Examples

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

[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;
    }
}

<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

Remarks

You use the StringValidatorAttribute to decorate a configuration property. This is to instruct .NET 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.

See also

• ConfigurationValidatorAttribute
• ConfigurationPropertyAttribute
• StringValidator