TimeSpanValidatorAttribute Class

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Source:

TimeSpanValidatorAttribute.cs

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

public ref class TimeSpanValidatorAttribute sealed : System::Configuration::ConfigurationValidatorAttribute

[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class TimeSpanValidatorAttribute : System.Configuration.ConfigurationValidatorAttribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type TimeSpanValidatorAttribute = class
    inherit ConfigurationValidatorAttribute

Public NotInheritable Class TimeSpanValidatorAttribute
Inherits ConfigurationValidatorAttribute

Inheritance

Object

Attribute

ConfigurationValidatorAttribute

TimeSpanValidatorAttribute

Attributes

AttributeUsageAttribute

Examples

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;
    }
}

<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 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>  

Remarks

You use the TimeSpanValidatorAttribute attribute to decorate a configuration property. This is to instruct .NET 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.

Constructors

TimeSpanValidatorAttribute()

Initializes a new instance of the TimeSpanValidatorAttribute class.

Fields

TimeSpanMaxValue	Gets the absolute maximum value allowed.
TimeSpanMinValue	Gets the absolute minimum value allowed.

Properties

ExcludeRange	Gets or sets a value that indicates whether to include or exclude the integers in the range as defined by MinValueString and MaxValueString.
MaxValue	Gets the absolute maximum TimeSpan value.
MaxValueString	Gets or sets the relative maximum TimeSpan value.
MinValue	Gets the absolute minimum TimeSpan value.
MinValueString	Gets or sets the relative minimum TimeSpan value.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)
ValidatorInstance	Gets an instance of the TimeSpanValidator class.
ValidatorType	Gets the type of the validator attribute. (Inherited from ConfigurationValidatorAttribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• ConfigurationValidatorAttribute
• ConfigurationSection
• ConfigurationPropertyAttribute
• TimeSpanValidator