Represents the results from a single regular expression match.
Assembly: System (in System.dll)
Thetype exposes the following members.
|Captures||Gets a collection of all the captures matched by the capturing group, in innermost-leftmost-first order (or innermost-rightmost-first order if the regular expression is modified with the RegexOptions.RightToLeft option). The collection may have zero or more items. (Inherited from Group.)|
|Empty||Gets the empty group. All failed matches return this empty match.|
|Groups||Gets a collection of groups matched by the regular expression.|
|Index||The position in the original string where the first character of the captured substring is found. (Inherited from Capture.)|
|Length||Gets the length of the captured substring. (Inherited from Capture.)|
|Success||Gets a value indicating whether the match is successful. (Inherited from Group.)|
|Value||Gets the captured substring from the input string. (Inherited from Capture.)|
|Equals(Object)||Determines whether the specified object is equal to the current object. (Inherited from Object.)|
|Finalize||Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)|
|GetHashCode||Serves as the default hash function. (Inherited from Object.)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|MemberwiseClone||Creates a shallow copy of the current Object. (Inherited from Object.)|
|NextMatch||Returns a new object with the results for the next match, starting at the position at which the last match ended (at the character after the last matched character).|
|Result||Returns the expansion of the specified replacement pattern.|
|Synchronized||Returns a instance equivalent to the one supplied that is suitable to share between multiple threads.|
|ToString||Retrieves the captured substring from the input string by calling the Value property. (Inherited from Capture.)|
The object is immutable and has no public constructor. An instance of the class is returned by the Regex.Match method and represents the first pattern match in a string. Subsequent matches are represented by objects returned by the Match.NextMatch method. In addition, a MatchCollection object that consists of zero, one, or more objects is returned by the Regex.Matches method.
If the Regex.Matches method fails to match a regular expression pattern in an input string, it returns an empty MatchCollection object. You can then use a foreach construct in C# or a For Each construct in Visual Basic to iterate the collection.
If the Regex.Match method fails to match the regular expression pattern, it returns a object that is equal to Match.Empty. You can use the Success property to determine whether the match was successful. The following example provides an illustration.
If a pattern match is successful, the Value property contains the matched substring, the Index property indicates the zero-based starting position of the matched substring in the input string, and the Length property indicates the length of matched substring in the input string.
Because a single match can involve multiple capturing groups, has a Groups property that returns the GroupCollection. The instance itself is equivalent to the first object in the collection, at Match.Groups (Match.Groups(0) in Visual Basic), which represents the entire match. You can access the captured groups in a match in the following ways:
You can iterate the members of the GroupCollection object by using a foreach (C#) or For Each (Visual Basic) construct.
You can use the GroupCollection.Item(Int32) property to retrieve groups by the number of the capturing group. Note that you can determine which numbered groups are present in a regular expression by calling the instance Regex.GetGroupNumbers method.
You can use the GroupCollection.Item(String) property to retrieve groups by the name of the capturing group. Note that you can determine which named groups are present in a regular expression by calling the instance Regex.GetGroupNames() method.
The following examples use the regular expression Console\.Write(Line)?. The regular expression is interpreted as follows:
Match the string "Console.Write". Note that the "." character is escaped so that it is interpreted as a literal period rather than as a wildcard that matches any character.
Match zero or one occurrence of the string "Line".
The following example calls the Regex.Matches(String, String) method to retrieve all pattern matches in an input string. It then iterates the objects in the returned MatchCollection object to display information about each match.
.NET FrameworkSupported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0
.NET Framework Client ProfileSupported in: 4, 3.5 SP1
Portable Class LibrarySupported in: Portable Class Library
.NET for Windows Store appsSupported in: Windows 8
.NET for Windows Phone appsSupported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1
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.