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

TimeSpanValidatorAttribute Class

Note: This class is new in the .NET Framework version 2.0.

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)

'Declaration
<AttributeUsageAttribute(AttributeTargets.Property)> _
Public NotInheritable Class TimeSpanValidatorAttribute
	Inherits ConfigurationValidatorAttribute
'Usage
Dim instance As TimeSpanValidatorAttribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Property) */ 
public final class TimeSpanValidatorAttribute extends ConfigurationValidatorAttribute
AttributeUsageAttribute(AttributeTargets.Property) 
public final class TimeSpanValidatorAttribute extends ConfigurationValidatorAttribute

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

You may apply TimeSpanValidatorAttribute objects to property types only.

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

<ConfigurationProperty("maxIdleTime", _
DefaultValue:="0:10:0", _
IsRequired:=False), _
TimeSpanValidator(MinValueString:="0:0:30", _
MaxValueString:="5:00:0", _
ExcludeRange:=False)> _
Public Property MaxIdleTime() As TimeSpan
    Get
        Return CType(Me("maxIdleTime"), TimeSpan)
    End Get
    Set(ByVal value As TimeSpan)
        Me("maxIdleTime") = value
    End Set
End Property

The following is an excerpt of the configuration file containing 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>

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

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

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

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2016 Microsoft