GroupCollection
Tip
This is a builtin dotnet type. The documentation and api interface are generated from dotnet source files.
Returns the set of captured groups in a single match. The collection is immutable (read-only) and has no public constructor.
Fields:
Count number
Returns the number of groups in the collection.
IsReadOnly boolean
Gets a value that indicates whether the collection is read-only.
IsSynchronized boolean
Gets a value that indicates whether access to the GroupCollection is synchronized (thread-safe).
Keys string[]
Gets a string enumeration that contains the name keys of the group collection.
SyncRoot Object
Gets an object that can be used to synchronize access to the GroupCollection.
Methods:
ContainsKey(key: string) : boolean
Determines whether the group collection contains a captured group identified by the specified name.
| Name | Type | Default | Summary |
| key | string | A string with the name of the captured group to locate. |
CopyTo(array: Group, arrayIndex: number) : nil
Copies the elements of the group collection to a Group array, starting at a particular array index.
| Name | Type | Default | Summary |
| array | Group | The one-dimensional array that is the destination of the elements copied from the group collection. The array must have zero-based indexing. | |
| arrayIndex | number | The zero-based index in array at which copying begins. |
GetPropertyKeys() : string[]
Returns a list of strings of all public property / field names. Useful for reflection on UserData in lua scripts
ToString() : string
Returns a string that represents the current object.
TryGetValue(key: string) : boolean, Group
Attempts to retrieve a group identified by the provided name key, if it exists in the group collection.
| Name | Type | Default | Summary |
| key | string | A string with the group name key to look for. |
| Type | Summary |
| boolean | |
| Group | When the method returns, the group whose name is key, if it is found; otherwise, |