Regex.Replace Method (String, String, String)
Within a specified input string, replaces all strings that match a specified regular expression with a specified replacement string.
Namespace: System.Text.RegularExpressions
Assembly: System (in System.dll)
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.
Return Value
Type: System.StringA new string that is identical to the input string, except that a replacement string takes the place of each matched string.
| Exception | Condition |
|---|---|
| ArgumentException | A regular expression parsing error occurred. |
| ArgumentNullException | input is null. -or- pattern is null. -or- replacement is null. |
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 Regular Expression Language Elements in the .NET Framework documentation. The search for matches starts at the beginning of the input string.
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.
Note: |
|---|
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 defines a regular expression, \s+, that matches one or more white-space characters. The replacement string, " ", replaces them with a single space character.
using System; using System.Text.RegularExpressions; public class Example { public static void Demo(System.Windows.Controls.TextBlock outputBlock) { string input = "This is text with far too much " + "whitespace."; string pattern = "\\s+"; string replacement = " "; string result = Regex.Replace(input, pattern, replacement); outputBlock.Text += String.Format("Original String: {0}", input) + "\n"; outputBlock.Text += String.Format("Replacement String: {0}", result) + "\n"; } } // The example displays the following output: // Original String: This is text with far too much whitespace. // Replacement String: This is text with far too much whitespace.
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
Note: