GroupCollection Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Returns the set of captured groups in a single match.


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

public class GroupCollection : ICollection, 

The GroupCollection type exposes the following members.

Public propertyCountReturns the number of groups in the collection.
Public propertyIsReadOnlyGets a value that indicates whether the collection is read-only.
Public propertyIsSynchronizedGets a value that indicates whether access to the GroupCollection is synchronized (thread-safe).
Public propertyItem[([(Int32])])Enables access to a member of the collection by integer index.
Public propertyItem[([(String])])Enables access to a member of the collection by string index.
Public propertySyncRootGets an object that can be used to synchronize access to the GroupCollection.

Public methodCopyToCopies all the elements of the collection to the given array beginning at the given index.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorProvides an enumerator that iterates through the collection.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

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 false and whose Value property equals String..::..Empty.

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