ConfigurationValidatorAttribute Class

Serves as the base class for the System.Configuration validator attribute types.

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

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

The ConfigurationValidatorAttribute type exposes the following members.

  NameDescription
Protected methodConfigurationValidatorAttribute()Initializes a new instance of the ConfigurationValidatorAttribute class.
Public methodConfigurationValidatorAttribute(Type)Initializes a new instance of the ConfigurationValidatorAttribute class using the specified validator type.
Top

  NameDescription
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public propertyValidatorInstanceGets the validator attribute instance.
Public propertyValidatorTypeGets the type of the validator attribute.
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
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 methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
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

All the ASP.NET configuration standard validator attribute types derive from ConfigurationValidatorAttribute. You can use this type to create your own custom validator attribute.

The following code examples demonstrate how to create two custom validators using the ConfigurationValidatorAttribute type. The first example performs validation using hard-coded parameters; the second example performs validation using the parameters assigned to it at the time it is applied to the related section property. This code example also contains three supporting files. The first file contains the custom section that uses the validators described above, the second file contains a custom converter type, and the third file contains the console application that builds and uses the custom validators and the section that contains them.

The following code example shows how to create a fixed validator with hard-coded parameters.

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

The following code example shows how to create a programmable validator.

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

The following code example shows how to create a custom section using the previous validators.

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

The following code example shows how to create a custom converter.

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

The following code example shows how to create the console application that builds and uses the custom validators and their containing section.

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

The following code example is a configuration excerpt used by the previous example.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <configSections>
        <section name="Cars" type="Samples.AspNet.SelectCar, ConfigValidatorAttribute, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" allowLocation="false" allowDefinition="Everywhere" allowExeDefinition="MachineToApplication" restartOnExternalChanges="true" requirePermission="true" />
    </configSections>
    <Cars commute="Make:AlfaRomeo Color:Blue Miles:10000 Year:2002"
        dream="Make:Ferrari Color:Red Miles:10 Year:2005" />
</configuration>

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft