Export (0) Print
Expand All

Regex.Replace Method (String, MatchEvaluator, Int32)

In a specified input string, replaces a specified maximum number of strings that match a regular expression pattern with a string returned by a MatchEvaluator delegate.

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

'Declaration
Public Function Replace ( _
	input As String, _
	evaluator As MatchEvaluator, _
	count As Integer _
) As String

Parameters

input
Type: System.String

The string to search for a match.

evaluator
Type: System.Text.RegularExpressions.MatchEvaluator

A custom method that examines each match and returns either the original matched string or a replacement string.

count
Type: System.Int32

The maximum number of times the replacement will occur.

Return Value

Type: System.String
A new string that is identical to the input string, except that a replacement string takes the place of each matched string. If the regular expression pattern is not matched in the current instance, the method returns the current instance unchanged.

ExceptionCondition
ArgumentNullException

input or evaluator is Nothing.

RegexMatchTimeoutException

A time-out occurred. For more information about time-outs, see the Remarks section.

The Regex.Replace(String, MatchEvaluator, Int32) method is useful for replacing a regular expression match if any of the following conditions is true:

  • The replacement string cannot readily be specified by a regular expression replacement pattern.

  • The replacement string results from some processing done on the matched string.

  • The replacement string results from conditional processing.

The method is equivalent to calling the Regex.Matches(String) method and passing the first count Match objects in the returned MatchCollection collection to the evaluator delegate.

The regular expression is the pattern defined by the constructor for the current Regex object.

The evaluator parameter is the delegate for a custom method that you define and that examines each match. The custom method must have the following signature to match the MatchEvaluator delegate.

Public Function MatchEvaluatorMethod(match As Match) As String

Your custom method returns a string that replaces the matched input.

The RegexMatchTimeoutException exception is thrown if the execution time of the replacement operation exceeds the time-out interval specified by the Regex.Regex(String, RegexOptions, TimeSpan) constructor. If you do not set a time-out interval when you call the constructor, the exception is thrown if the operation exceeds any time-out value established for the application domain in which the Regex object is created. If no time-out is defined in the Regex constructor call or in the application domain's properties, or if the time-out value is Regex.InfiniteMatchTimeout, no exception is thrown

Because the method returns input unchanged if there is no match, you can use the Object.ReferenceEquals method to determine whether the method has made any replacements to the input string.

The following example uses a regular expression to deliberately misspell half of the words in a list. It uses the regular expression \w*(ie|ei)\w* to match words that include the characters "ie" or "ei". It passes the first half of the matching words to the ReverseLetter method, which, in turn, uses the Replace(String, String, String, RegexOptions) method to reverse "i" and "e" in the matched string. The remaining words remain unchanged.

Imports System.Text.RegularExpressions

Module Example
   Public Sub Main()
      Dim input As String = "deceive relieve achieve belief fierce receive" 
      Dim pattern As String = "\w*(ie|ei)\w*" 
      Dim rgx As New Regex(pattern, RegexOptions.IgnoreCase)
      Console.WriteLine("Original string: " + input)

      Dim result As String = rgx.Replace(input, AddressOf ReverseLetter, 
                                           input.Split(" "c).Length \ 2)
      Console.WriteLine("Returned string: " + result)
   End Sub 

   Public Function ReverseLetter(match As Match) As String 
      Return Regex.Replace(match.Value, "([ie])([ie])", "$2$1", 
                           RegexOptions.IgnoreCase)            
   End Function 
End Module 
' The example displays the following output: 
'    Original string: deceive relieve achieve belief fierce receive 
'    Returned string: decieve releive acheive belief fierce receive

The regular expression \w*(ie|ei)\w* is defined as shown in the following table.

Pattern

Description

\w*

Match zero or more word characters.

(ie|ei)

Match either "ie" or "ei".

\w*

Match zero or more word characters.

The regular expression pattern ([ie])([ie]) in the ReverseLetter method matches the first "i" or "e" in the diphthong "ie" or "ei" and assigns the letter to the first capturing group. It matches the second "i" or "e" and assigns the letter to the second capturing group. The two characters are then reversed by calling the Replace(String, String, String) method with the replacement pattern $2$1.

.NET Framework

Supported in: 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 Silverlight 8.1, Windows Phone Silverlight 8

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