Regex.Match Method (String)
Searches the specified input string for the first occurrence of the regular expression specified in the Regex constructor.
Namespace: System.Text.RegularExpressions
Assembly: System (in System.dll)
Parameters
- input
- Type: System.String
The string to search for a match.
Return Value
Type: System.Text.RegularExpressions.MatchAn object that contains information about the match.
| Exception | Condition |
|---|---|
| ArgumentNullException | input is null. |
You can determine whether the regular expression pattern has been found in the input string by checking the value of the returned Match object's Success property. If a match is successful, the returned Match object's Value property contains the substring from input that matches the regular expression pattern. If no match is found, its value is String.Empty.
This method returns the first substring in input that matches the regular expression pattern. You can retrieve subsequent matches by repeatedly calling the returned Match object's NextMatch method. You can also retrieve all matches in a single method call by calling the Regex.Matches(String) method.
The following example finds regular expression pattern matches in a string, then lists the matched groups, captures, and capture positions.
using System; using System.Text.RegularExpressions; class Example { public static void Demo(System.Windows.Controls.TextBlock outputBlock) { string text = "One car red car blue car"; string pat = @"(\w+)\s+(car)"; // Compile the regular expression. Regex r = new Regex(pat, RegexOptions.IgnoreCase); // Match the regular expression pattern against a text string. Match m = r.Match(text); int matchCount = 0; while (m.Success) { outputBlock.Text += "Match" + (++matchCount) + "\n"; for (int i = 1; i <= 2; i++) { Group g = m.Groups[i]; outputBlock.Text += "Group" + i + "='" + g + "'" + "\n"; CaptureCollection cc = g.Captures; for (int j = 0; j < cc.Count; j++) { Capture c = cc[j]; outputBlock.Text += "Capture" + j + "='" + c + "', Position=" + c.Index + "\n"; } } m = m.NextMatch(); } } } //This example displays the following output: // Match1 // Group1='One' // Capture0='One', Position=0 // Group2='car' // Capture0='car', Position=4 // Match2 // Group1='red' // Capture0='red', Position=8 // Group2='car' // Capture0='car', Position=12 // Match3 // Group1='blue' // Capture0='blue', Position=16 // Group2='car' // Capture0='car', Position=21
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.