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.

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

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

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Property)>]
type TimeSpanValidatorAttribute =  
    class
        inherit ConfigurationValidatorAttribute
    end

The TimeSpanValidatorAttribute type exposes the following members.

  NameDescription
Public methodTimeSpanValidatorAttributeInitializes a new instance of the TimeSpanValidatorAttribute class.
Top

  NameDescription
Public propertyExcludeRangeGets or sets a value that indicates whether to include or exclude the integers in the range as defined by MinValueString and MaxValueString.
Public propertyMaxValueGets the absolute maximum TimeSpan value.
Public propertyMaxValueStringGets or sets the relative maximum TimeSpan value.
Public propertyMinValueGets the absolute minimum TimeSpan value.
Public propertyMinValueStringGets or sets the relative minimum TimeSpan value.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public propertyValidatorInstanceGets an instance of the TimeSpanValidator class. (Overrides ConfigurationValidatorAttribute.ValidatorInstance.)
Public propertyValidatorTypeGets the type of the validator attribute. (Inherited from ConfigurationValidatorAttribute.)
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
Public fieldStatic memberTimeSpanMaxValueGets the absolute maximum value allowed.
Public fieldStatic memberTimeSpanMinValueGets the absolute minimum value allowed.
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

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.

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

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

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.

Community Additions

ADD
Show:
© 2014 Microsoft