TimeSpanValidator Class

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Package:

System.Configuration.ConfigurationManager v8.0.0

Source:

TimeSpanValidator.cs

Provides validation of a TimeSpan object.

public ref class TimeSpanValidator : System::Configuration::ConfigurationValidatorBase

public class TimeSpanValidator : System.Configuration.ConfigurationValidatorBase

type TimeSpanValidator = class
    inherit ConfigurationValidatorBase

Public Class TimeSpanValidator
Inherits ConfigurationValidatorBase

Inheritance

Object

ConfigurationValidatorBase

TimeSpanValidator

Examples

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

Imports System.Configuration

Namespace Samples.AspNet
  Class UsingStringValidator
    Public Shared Sub Main()

      ' Display title.
      Console.WriteLine("ASP.NET Validators")
      Console.WriteLine()

      ' Create string and validator.
      Dim testVal As String = "filename"
      Dim myStrValidator As StringValidator = New StringValidator(1, 8, "$%^")

      ' Create TimeSpan and Validator.
      Dim testTimeSpan As TimeSpan = New TimeSpan(0, 1, 5)
      Dim minTimeSpan As TimeSpan = New TimeSpan(0, 1, 0)
      Dim maxTimeSpan As TimeSpan = New TimeSpan(0, 1, 10)
      Dim myTimeSpanValidator As TimeSpanValidator = _
       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 e As Exception
        ' Validation failed.
        Console.WriteLine("Error: {0}", e.Message.ToString())
      End Try

      ' Display and wait.
      Console.ReadLine()
    End Sub
  End Class
End Namespace

Remarks

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.

Constructors

TimeSpanValidator(TimeSpan, TimeSpan)	Initializes a new instance of the TimeSpanValidator class, based on supplied parameters.
TimeSpanValidator(TimeSpan, TimeSpan, Boolean)	Initializes a new instance of the TimeSpanValidator class, based on supplied parameters.
TimeSpanValidator(TimeSpan, TimeSpan, Boolean, Int64)	Initializes a new instance of the TimeSpanValidator class, based on supplied parameters.

Methods

CanValidate(Type)	Determines whether the type of the object can be validated.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Validate(Object)	Determines whether the value of an object is valid.

See also

• ConfigurationValidatorBase