GroupTable Class |
Group tables store the list of groups in a Rhino document.
Inheritance HierarchySystemObject
Rhino.FileIOCommonComponentTableGroup
Rhino.DocObjects.TablesRhinoDocCommonTableGroup
Rhino.DocObjects.TablesGroupTable
Rhino.FileIOCommonComponentTableGroup
Rhino.DocObjects.TablesRhinoDocCommonTableGroup
Rhino.DocObjects.TablesGroupTable
Namespace: Rhino.DocObjects.Tables
Assembly: RhinoCommon (in RhinoCommon.dll)
SyntaxThe GroupTable type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ComponentType | (Overrides CommonComponentTableTComponentType.) |
| Count |
Returns the count of all items, including deleted ones.
(Inherited from CommonComponentTableT.) |
| Document | Document that owns this table. (Inherited from RhinoDocCommonTableT.) |
| Item |
Conceptually, the group table is an array of groups.
The operator[] can be used to get individual groups.
A group is either active or deleted and this state is reported by Group.IsDeleted.
|
Methods| Name | Description | |
|---|---|---|
 | Add | Adds a new empty group to the group table. |
 | Add(IEnumerableGuid) |
Adds a new group to the group table with a set of objects.
|
| Add(String) | Adds a new empty group to the group table. |
| Add(String, IEnumerableGuid) |
Adds a new group to the group table with a set of objects.
|
| AddToGroup(Int32, IEnumerableGuid) |
Adds a list of objects to an existing group.
|
| AddToGroup(Int32, Guid) |
Adds an object to an existing group.
|
| ChangeGroupName |
Changes the name of a group.
|
| Clear |
Marks all items as deleted.
(Inherited from CommonComponentTableT.) |
| Delete(Group) | (Overrides CommonComponentTableTDelete(T).) |
| Delete(Int32) |
Deletes a group from this table.
Deleted groups are kept in the runtime group table so that undo will work with groups. Call IsDeleted() to determine if a group is deleted. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| FindId |
Uses the guid to find a model component. Deleted objects cannot be found by id.
The guid is the value that is stored in the .Id property.
In a single document, no two active objects have the same guid. If an object is
replaced with a new object, then the guid persists. For example, if the _Move command
moves an object, then the moved object inherits its guid from the starting object.
If the Copy command copies an object, then the copy gets a new guid. This guid persists
through file saving/opening operations. This function will not find grip objects.
(Inherited from CommonComponentTableT.) |
| FindIndex |
Retrieves a Group object based on Index. This search type of search is discouraged.
We are moving towards using only IDs for all tables.
|
| FindName |
Finds a group given its name. Returns the instance, rather than the index.
|
| FindNameHash |
Finds a group given its name hash.
|
| GetEnumerator |
Returns the enumerator that yields all items.
(Inherited from CommonComponentTableT.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GroupMembers |
Gets an array of all of the objects in a group.
|
| GroupName |
Returns the name of a group.
|
| GroupNames |
Returns an array of all group names.
|
| GroupObjectCount |
Returns the number of objects that are members of a group.
|
| Hide |
Hides all objects that are members of a group.
|
| IsDeleted |
Verifies a group is deleted.
|
| Lock |
Locks all objects that are members of a group.
|
| Show |
Shows, or unhides, all objects that are members of a group.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Undelete |
Undeletes a previously deleted group.
|
| Unlock |
Unlocks all objects that are members of a group.
|
See Also