Export (0) Print
Expand All

TimeSpanValidator Class

Provides validation of a TimeSpan object.

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

'Declaration
Public Class TimeSpanValidator _
	Inherits ConfigurationValidatorBase

The TimeSpanValidator type exposes the following members.

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

  NameDescription
Public methodCanValidateDetermines whether the type of the object can be validated. (Overrides ConfigurationValidatorBase.CanValidate(Type).)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
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 methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodValidateDetermines 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.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft