Returns the set of captured groups in a single match.
Assembly: System (in System.dll)
Thetype exposes the following members.
|Count||Returns the number of groups in the collection.|
|IsReadOnly||Gets a value that indicates whether the collection is read-only.|
|IsSynchronized||Gets a value that indicates whether access to the is synchronized (thread-safe).|
|Item(Int32)||Enables access to a member of the collection by integer index.|
|Item(String)||Enables access to a member of the collection by string index.|
|SyncRoot||Gets an object that can be used to synchronize access to the .|
|CopyTo||Copies all the elements of the collection to the given array beginning at the given index.|
|Equals(Object)||Determines whether the specified object is equal to the current object. (Inherited from Object.)|
|GetEnumerator||Provides an enumerator that iterates through the collection.|
|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.)|
|ToString||Returns a string that represents the current object. (Inherited from Object.)|
|AsParallel||Enables parallelization of a query. (Defined by ParallelEnumerable.)|
|AsQueryable||Converts an IEnumerable to an IQueryable. (Defined by Queryable.)|
|Cast(TResult)||Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)|
|OfType(TResult)||Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)|
|ICollection.CopyTo||Copies all the elements of the collection to the specified array beginning at the specified index.|
|ICollection.IsSynchronized||Gets a value that indicates whether access to the collection is synchronized (thread-safe).|
|ICollection.SyncRoot||Gets an object that can be used to synchronize access to the collection.|
The class consists of one or more Group objects that provide information about captured groups in a regular expression match. The collection is immutable (read-only) and has no public constructor. A object is returned by the Match.Groups property.
The collection contains one or more System.Text.RegularExpressions.Group objects. If the match is successful, the first element in the collection contains the Group object that corresponds to the entire match. Each subsequent element represents a captured group, if the regular expression includes capturing groups. Matches from numbered (unnamed) capturing groups appear in numeric order before matches from named capturing groups. If the match is unsuccessful, the collection contains a single System.Text.RegularExpressions.Group object whose Success property is false and whose Value property equals String.Empty. For more information, see the "Grouping Constructs and Regular Expression Objects" section in the Grouping Constructs in Regular Expressions article.
To iterate through the members of the collection, you should use the collection iteration construct provided by your language (such as foreach in C# and For Each…Next in Visual Basic) instead of retrieving the enumerator that is returned by the GetEnumerator method. In addition, you can access individual numbered captured groups from the Item(Int32) property (the indexer in C#), and you can access individual named captured groups from the Item(String) property. Note that you can retrieve an array containing the numbers of all capturing groups and the names of all capturing groups by calling the Regex.GetGroupNumbers and Regex.GetGroupNames method, respectively. Note that both are instance methods; they require that you instantiate a Regex object that represents the regular expression to be matched.
The following example uses a regular expression with capturing groups to extract information about trademarks and registered trademarks used in text. The regular expression pattern is \b(\w+?)([\u00AE\u2122]), which is interpreted as shown in the following table.
Look for a word boundary.
Look for one or more word characters. Together, these form the trademarked name. (Note that this regular expression assumes that a trademark consists of a single word.) This is the first capturing group.
Look for either the ® or the ™ character. This is the second capturing group.
For each match, the contains three Group objects. The first object contains the string that matches the entire regular expression. The second object, which represents the first captured group, contains the product name. The third object, which represents the second captured group, contains the trademark or registered trademark symbol.