Export (0) Print
Expand All

Regex Constructor (String)

Initializes a new instance of the Regex class for the specified regular expression.

Namespace:  System.Text.RegularExpressions
Assembly:  System (in System.dll)

'Declaration
Public Sub New ( _
	pattern As String _
)

Parameters

pattern
Type: System.String

The regular expression pattern to match.

ExceptionCondition
ArgumentException

A regular expression parsing error occurred.

ArgumentNullException

pattern is Nothing.

The pattern parameter consists of regular expression language elements that symbolically describe the string to match. For more information about regular expressions, see the .NET Framework Regular Expressions and Regular Expression Language - Quick Reference topics.

Calling the Regex(String) constructor is equivalent to calling the Regex(String, RegexOptions) constructor with a value of None for the options argument.

A Regex object is immutable, which means that it can be used only for the match pattern you define when you create it. However, it can be used any number of times without being recompiled.

This constructor instantiates a regular expression object that attempts a case-sensitive match of any alphabetical characters defined in pattern. For a case-insensitive match, use the Regex.Regex(String, RegexOptions) constructor.

Notes to Callers

This constructor creates a Regex object that uses the default time-out value of the application domain in which it is created. If a time-out value has not been defined for the application domain, the Regex object uses the value InfiniteMatchTimeout, which prevents the operation from timing out. The recommended constructor for creating a Regex object is Regex.Regex(String, RegexOptions, TimeSpan), which lets you set the time-out interval.

The following example illustrates how to use this constructor to instantiate a regular expression that matches any word that begins with the letters "a" or "t".

Dim pattern As String = "\b[at]\w+" 
Dim text As String = "The threaded application ate up the thread pool as it executed." 
Dim matches As MatchCollection

Dim defaultRegex As New Regex(pattern)
' Get matches of pattern in text
matches = defaultRegex.Matches(text)
Console.WriteLine("Parsing '{0}'", text)
' Iterate matches    
For ctr As Integer = 0 to matches.Count - 1
   Console.WriteLine("{0}. {1}", ctr, matches(ctr).Value)
Next 
' This example displays the following output to the console: 
'       Parsing 'The threaded application ate up the thread pool as it executed.' 
'       0. threaded 
'       1. application 
'       2. ate 
'       3. the 
'       4. thread 
'       5. as      

Note that the regular expression pattern cannot match the word "The" at the beginning of the text, because comparisons are case-sensitive by default. For an example of case-insensitive comparison, see the Regex(String, RegexOptions) constructor.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, 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.

Show:
© 2014 Microsoft