Export (0) Print
Expand All

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)

[AttributeUsageAttribute(AttributeTargets.Property)] 
public sealed class TimeSpanValidatorAttribute : ConfigurationValidatorAttribute
/** @attribute AttributeUsageAttribute(AttributeTargets.Property) */ 
public final class TimeSpanValidatorAttribute extends ConfigurationValidatorAttribute
AttributeUsageAttribute(AttributeTargets.Property) 
public final class TimeSpanValidatorAttribute extends ConfigurationValidatorAttribute
Not applicable.

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>

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 Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft