TimeSpanValidatorAttribute Class
TOC
Collapse the table of content
Expand the table of content

TimeSpanValidatorAttribute Class

 

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

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

System.Object
  System.Attribute
    System.Configuration.ConfigurationValidatorAttribute
      System.Configuration.TimeSpanValidatorAttribute

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

NameDescription
System_CAPS_pubmethodTimeSpanValidatorAttribute()

Initializes a new instance of the TimeSpanValidatorAttribute class.

NameDescription
System_CAPS_pubpropertyExcludeRange

Gets or sets a value that indicates whether to include or exclude the integers in the range as defined by MinValueString and MaxValueString.

System_CAPS_pubpropertyMaxValue

Gets the absolute maximum TimeSpan value.

System_CAPS_pubpropertyMaxValueString

Gets or sets the relative maximum TimeSpan value.

System_CAPS_pubpropertyMinValue

Gets the absolute minimum TimeSpan value.

System_CAPS_pubpropertyMinValueString

Gets or sets the relative minimum TimeSpan value.

System_CAPS_pubpropertyTypeId

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

System_CAPS_pubpropertyValidatorInstance

Gets an instance of the TimeSpanValidator class.(Overrides ConfigurationValidatorAttribute.ValidatorInstance.)

System_CAPS_pubpropertyValidatorType

Gets the type of the validator attribute.(Inherited from ConfigurationValidatorAttribute.)

NameDescription
System_CAPS_pubmethodEquals(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticTimeSpanMaxValue

Gets the absolute maximum value allowed.

System_CAPS_pubfieldSystem_CAPS_staticTimeSpanMinValue

Gets the absolute minimum value allowed.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

You use the TimeSpanValidatorAttribute attribute to decorate a configuration property. This is to instruct the .NET Framework to validate the property using the TimeSpanValidator class and pass to it the value of the decorating parameters.

You can apply TimeSpanValidatorAttribute objects to property types only.

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

[ConfigurationProperty("maxIdleTime",
    DefaultValue = "0:10:0",
    IsRequired = false)]
[TimeSpanValidator(MinValueString = "0:0:30",
    MaxValueString = "5:00:0",
    ExcludeRange = false)]
public TimeSpan MaxIdleTime
{
    get
    {
        return (TimeSpan)this["maxIdleTime"];
    }
    set
    {
        this["maxIdleTime"] = value;
    }
}

The following example is an excerpt of the configuration file that contains the custom section used by the previous sample.

<configuration xmlns="http://schemas.microsoft.com/.NetConfiguration/v2.0">
  <configSections>
    <section name="custom" type="Microsoft.Samples.AspNet.Configuration.SampleSection, ConfigurationValidatorAttribute" />
  </configSections>
  <custom fileName="NewFile.txt" maxSize="1000" maxAttempts="101" maxUsers="2500" maxIdleTime="00:15:00" />
</configuration>

.NET Framework
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft