12sss

GroupCollection Class

Returns the set of captured groups in a single match.

Namespace:  System.Text.RegularExpressions
Assembly:  System (in System.dll)

 

Syntax

 

 

[SerializableAttribute] public class GroupCollection : ICollection, IEnumerable

 

 

System.Object
  System.Text.RegularExpressions.GroupCollection

 

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

 

Remarks

The collection is immutable (read-only) and has no public constructor. A GroupCollection 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. If the match is unsuccessful, the collection contains a single System.Text.RegularExpressions.Group object whose Success property is falseand whose Value property equals String.Empty.

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.

 

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.

 

For each match, the GroupCollection 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.

using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.IO; using System.Text.RegularExpressions; namespace MyConsole { class Program { static void Main(string[] args) { string pattern = @"/b(/w+?)([/u00AE/u2122])"; string input = "Microsoft® Office Professional Edition combines several office " + "productivity products, including Word, Excel®, Access®, Outlook®, " + "PowerPoint®, and several others. Some guidelines for creating " + "corporate documents using these productivity tools are available " + "from the documents created using Silverlight™ on the corporate " + "intranet site."; MatchCollection matches = Regex.Matches(input, pattern); foreach (Match match in matches) { GroupCollection groups = match.Groups; Console.WriteLine("{0}: {1}", groups[2], groups[1]); } Console.WriteLine(); Console.WriteLine("Found {0} trademarks or registered trademarks.", matches.Count); } } }

 

?: Microsoft ?: Excel ?: Access ?: Outlook ?: PowerPoint ?: Silverlight Found 6 trademarks or registered trademarks. Press any key to continue . . .

The example displays the following output:

Pattern	Description
/b	Look for a word boundary.
(/w+?)	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.
([/u00AE/u2122])	Look for either the ® or the ™ character. This is the second capturing group.

Examples

Thread Safety

Inheritance Hierarchy