Match.Result(String) Method

Reference

Definition

Namespace:: System.Text.RegularExpressions

Assembly:: System.Text.RegularExpressions.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: Match.cs

Source:: Match.cs

Source:: Match.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the expansion of the specified replacement pattern.

public:
 virtual System::String ^ Result(System::String ^ replacement);

public virtual string Result (string replacement);

abstract member Result : string -> string
override this.Result : string -> string

Public Overridable Function Result (replacement As String) As String

Parameters

replacement: String

The replacement pattern to use.

Returns

String

The expanded version of the replacement parameter.

Exceptions

ArgumentNullException

replacement is null.

NotSupportedException

Expansion is not allowed for this pattern.

Examples

The following example replaces the hyphens that begin and end a parenthetical expression with parentheses.

using System;
using System.Text.RegularExpressions;

public class Example
{
   public static void Main()
   {
      string pattern = "--(.+?)--";
      string replacement = "($1)";
      string input = "He said--decisively--that the time--whatever time it was--had come.";
      foreach (Match match in Regex.Matches(input, pattern))
      {
         string result = match.Result(replacement);
         Console.WriteLine(result);
      }
   }
}
// The example displays the following output:
//       (decisively)
//       (whatever time it was)

Imports System.Text.RegularExpressions

Module Example
   Public Sub Main()
      Dim pattern As String = "--(.+?)--"
      Dim replacement As String = "($1)"
      Dim input As String = "He said--decisively--that the time--whatever time it was--had come."
      For Each match As Match In Regex.Matches(input, pattern)
         Dim result As String = match.Result(replacement)
         Console.WriteLine(result)
      Next
   End Sub
End Module
' The example displays the following output:
'       (decisively)
'       (whatever time it was)

The regular expression pattern --(.+?)-- is interpreted as shown in the following table.

Pattern	Description
`--`	Match two hyphens.
`(.+?)`	Match any character one or more times, but as few times as possible. This is the first capturing group.
`--`	Match two hyphens.

Note that the regular expression pattern --(.+?)-- uses the lazy quantifier +?. If the greedy quantifier + were used instead, the regular expression engine would find only a single match in the input string.

The replacement string ($1) replaces the match with the first captured group, which is enclosed in parentheses.

Remarks

Whereas the Regex.Replace method replaces all matches in an input string with a specified replacement pattern, the Result method replaces a single match with a specified replacement pattern. Because it operates on an individual match, it is also possible to perform processing on the matched string before you call the Result method.

The replacement parameter is a standard regular expression replacement pattern. It can consist of literal characters and regular expression substitutions. For more information, see Substitutions.

Applies to

Share via