RegexStringValidator Class (System.Configuration)

Switch View :
ScriptFree
.NET Framework Class Library
RegexStringValidator Class

Provides validation of a string based on the rules provided by a regular expression.

Inheritance Hierarchy

System.Object
  System.Configuration.ConfigurationValidatorBase
    System.Configuration.RegexStringValidator

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

Visual Basic
Public Class RegexStringValidator _
	Inherits ConfigurationValidatorBase
C#
public class RegexStringValidator : ConfigurationValidatorBase
Visual C++
public ref class RegexStringValidator : public ConfigurationValidatorBase
F#
type RegexStringValidator =  
    class
        inherit ConfigurationValidatorBase
    end

The RegexStringValidator type exposes the following members.

Constructors

  Name Description
Public method RegexStringValidator Initializes a new instance of the RegexStringValidator class.
Top
Methods

  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
Remarks

The RegexStringValidator object contains the rules necessary to validate a string object based on a regular expression. The rules are established when an instance of the RegexStringValidator class is created.

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.

Examples

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

Visual Basic

Imports System
Imports System.Configuration

Namespace Microsoft.Samples.AspNet.Validators
  Class UsingRegexStringValidator
    Public Shared Sub Main()

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

      ' Create RegexString and Validator.
      Dim testString As String = "someone@example.com"
      Dim regexString As String = _
       "^[a-zA-Z\.\-_]+@([a-zA-Z\.\-_]+\.)+[a-zA-Z]{2,4}$"
      Dim myRegexValidator As RegexStringValidator = _ 
       New RegexStringValidator(regexString)

      ' Determine if the object to validate can be validated.
      Console.WriteLine("CanValidate: {0}", _
        myRegexValidator.CanValidate(testString.GetType()))

      Try
        ' Attempt validation.
        myRegexValidator.Validate(testString)
        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


C#

using System;
using System.Configuration;

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

      // Create RegexString and Validator.
      string testString = "someone@example.com";
      string regexString = 
       @"^[a-zA-Z\.\-_]+@([a-zA-Z\.\-_]+\.)+[a-zA-Z]{2,4}$";
      RegexStringValidator myRegexValidator = 
       new RegexStringValidator(regexString);

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

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

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


Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

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.
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference