Export (0) Print
Expand All

Regex.Replace Method (String, String, String, RegexOptions)

Updated: May 2010

Within a specified input string, replaces all strings that match a specified regular expression with a specified replacement string. Specified options modify the matching operation.

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

'Declaration
Public Shared Function Replace ( _
	input As String, _
	pattern As String, _
	replacement As String, _
	options As RegexOptions _
) As String
'Usage
Dim input As String 
Dim pattern As String 
Dim replacement As String 
Dim options As RegexOptions 
Dim returnValue As String 

returnValue = Regex.Replace(input, _
	pattern, replacement, options)

Parameters

input
Type: System.String

The string to search for a match.

pattern
Type: System.String

The regular expression pattern to match.

replacement
Type: System.String

The replacement string.

options
Type: System.Text.RegularExpressions.RegexOptions

A bitwise OR combination of the enumeration values.

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.

ExceptionCondition
ArgumentException

A regular expression parsing error has occurred.

ArgumentNullException

input is Nothing.

-or-

pattern is Nothing.

-or-

replacement is Nothing.

ArgumentOutOfRangeException

options is not a valid bitwise combination of RegexOptions values.

The static Replace methods are equivalent to constructing a Regex object with the specified regular expression pattern and calling the instance method Replace.

The pattern parameter consists of various regular expression language elements that symbolically describe the string to match. For more information about regular expressions, see .NET Framework Regular Expressions and Regular Expression Language - Quick Reference. If the options parameter specifies the RegexOptions.RightToLeft enumeration value, the search for matches begins from the end of the input string and proceeds from right to left; otherwise, the search begins from the start of the input string and proceeds from left to right.

The replacement parameter specifies the string that is to replace each match in input. replacement can consist of any combination of literal text and substitutions. For example, the replacement pattern a*${test}b inserts the string "a*" followed by the substring that is matched by the test capturing group, if any, followed by the string "b". The * character is not recognized as a metacharacter within a replacement pattern.

NoteNote:

Substitutions are the only regular expression language elements that are recognized in a replacement pattern. All other regular expression language elements, including character escapes, are allowed in regular expression patterns only and are not recognized in replacement patterns.

The following example uses the Replace(String, String, String) method to replace the local machine and drive names in a UNC path with a local file path. The regular expression uses the Environment.MachineName property to include the name of the local computer, and the Environment.GetLogicalDrives method to include the names of the logical drives. All regular expression string comparisons are case-insensitive. To run the example successfully, you should replace the literal string "MyMachine" with your local machine name.

Imports System.Text.RegularExpressions

Module Example
   Public Sub Main()
      ' Get drives available on local computer and form into a single character expression. 
      Dim drives() As String = Environment.GetLogicalDrives()
      Dim driveNames As String = Nothing 
      For Each drive As String In drives
         driveNames += drive.Substring(0,1)
      Next 
      ' Create regular expression pattern dynamically based on local machine information. 
      Dim pattern As String = "\\\\(?i:" + Environment.MachineName + ")(?:\.\w+)*\\((?i:[" + driveNames + "]))\$" 

      Dim replacement As String = "$1:" 
      Dim uncPaths() AS String = {"\\MyMachine.domain1.mycompany.com\C$\ThingsToDo.txt", _
                                  "\\MyMachine\c$\ThingsToDo.txt", _
                                  "\\MyMachine\d$\documents\mydocument.docx" } 

      For Each uncPath As String In uncPaths
         Console.WriteLine("Input string: " + uncPath)
         Console.WriteLine("Returned string: " + Regex.Replace(uncPath, pattern, replacement))
         Console.WriteLine()
      Next 
   End Sub 
End Module 
' The example displays the following output if run on a machine whose name is 
' MyMachine: 
'    Input string: \\MyMachine.domain1.mycompany.com\C$\ThingsToTo.txt 
'    Returned string: C:\ThingsToDo.txt 
'     
'    Input string: \\MyMachine\c$\ThingsToDo.txt 
'    Returned string: c:\ThingsToDo.txt 
'     
'    Input string: \\MyMachine\d$\documents\mydocument.docx 
'    Returned string: d:\documents\mydocument.docx

The regular expression pattern is defined by the following expression:

"\\\\(?i:" + Environment.MachineName + ")(?:\.\w+)*\\((?i:[" + driveNames + "]))\$"

The following table shows how the regular expression pattern is interpreted.

Pattern

Description

\\\\

Match two consecutive backslash (\) characters. Because the backslash character is interpreted as the escape character, each backslash must be escaped with another backslash.

(?i:" + Environment.MachineName + ")

Perform a case-insensitive match of the string that is returned by the Environment.MachineName property.

(?:\.\w+)*

Match the period (.) character followed by one or more word characters. This match can occur zero or more times. The matched subexpression is not captured.

\\

Match a backslash (\) character.

((?i:[" + driveNames + ]"))

Perform a case-insensitive match of the character class that consists of the individual drive lettters. This match is the first captured subexpression.

\$

Match the literal dollar sign ($) character.

The replacement pattern $1 replaces the entire match with the first captured subexpression. That is, it replaces the UNC machine and drive name with the drive letter.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Date

History

Reason

May 2010

Added an explanation of the replacement pattern in the example.

Customer feedback.

December 2009

Expanded the Remarks section.

Customer feedback.

July 2009

Included additional exception information.

Content bug fix.

May 2009

Added an example.

Customer feedback.

Community Additions

ADD
Show:
© 2014 Microsoft