This topic has not yet been rated - Rate this topic

TimeSpanValidator Class

Provides validation of a TimeSpan object.

System.Object
  System.Configuration.ConfigurationValidatorBase
    System.Configuration.TimeSpanValidator

Namespace:  System.Configuration
Assembly:  System.Configuration (in System.Configuration.dll)
public class TimeSpanValidator : ConfigurationValidatorBase

The TimeSpanValidator type exposes the following members.

  Name Description
Public method TimeSpanValidator(TimeSpan, TimeSpan) Initializes a new instance of the TimeSpanValidator class, based on supplied parameters.
Public method TimeSpanValidator(TimeSpan, TimeSpan, Boolean) Initializes a new instance of the TimeSpanValidator class, based on supplied parameters.
Public method TimeSpanValidator(TimeSpan, TimeSpan, Boolean, Int64) Initializes a new instance of the TimeSpanValidator class, based on supplied parameters.
Top
  Name Description
Public method CanValidate Determines whether the type of the object can be validated. (Overrides ConfigurationValidatorBase.CanValidate(Type).)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Validate Determines whether the value of an object is valid. (Overrides ConfigurationValidatorBase.Validate(Object).)
Top

The TimeSpanValidator class is used to ensure that a TimeSpan object meets specific criteria. The TimeSpanValidator constructor with two parameters ensures that both a minimum and a maximum TimeSpan value are adhered to. The TimeSpanValidator constructor with three parameters checks both the minimum and maximum TimeSpan values, as well as whether the validation range is exclusive. The TimeSpanValidator constructor with four parameters checks the previous three parameters and also checks whether the TimeSpan value is equal to a specific number of seconds.

The CanValidate method determines whether the object type being validated matches the expected type. The object being validated is passed as a parameter of the Validate method.

The following code example demonstrates how to use the TimeSpanValidator type.


using System;
using System.Configuration;

namespace Samples.AspNet
{
  class UsingTimeSpanValidator
  {
    static void Main(string[] args)
    {
      // Display title.
      Console.WriteLine("ASP.NET Validators");
      Console.WriteLine();

      // Create TimeSpan and Validator.
      TimeSpan testTimeSpan = new TimeSpan(0,1,05);
      TimeSpan minTimeSpan = new TimeSpan(0,1,0);
      TimeSpan maxTimeSpan = new TimeSpan(0,1,10);
      TimeSpanValidator myTimeSpanValidator = new TimeSpanValidator(minTimeSpan, maxTimeSpan, false, 65);

      // Determine if the object to validate can be validated.
      Console.WriteLine("CanValidate: {0}",
        myTimeSpanValidator.CanValidate(testTimeSpan.GetType()));

      try
      {
        // Attempt validation.
        myTimeSpanValidator.Validate(testTimeSpan);
        Console.WriteLine("Validated.");
      }
      catch (ArgumentException e)
      {
        // Validation failed.
        Console.WriteLine("Error: {0}", e.Message.ToString());
      }

      // Display and wait
      Console.ReadLine();
    }
  }
}


.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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ