RhinoCommon API
GroupTable Class |
Group tables store the list of groups in a Rhino document.
Inheritance HierarchyNamespace: Rhino.DocObjects.Tables
Assembly: RhinoCommon (in RhinoCommon.dll)
SyntaxThe GroupTable type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ComponentType | (Overrides CommonComponentTableTComponentType.) |
| Count | Number of groups in the group table. In Rhino for Windows 6.14, this member is inherited from CommonComponentTableTCount. |
| Document | Document that owns this group table. In Rhino for Windows 6.14, this member is inherited from RhinoDocCommonTableTDocument. |
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 | |
| Clear |
Marks all items as deleted.
(Inherited from CommonComponentTableT.) |
| 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. |
| Delete(Group) | (Overrides CommonComponentTableTDelete(T).) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Find | Finds a group with a given name. |
| 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/openning operations. This function will not find grip objects.
(Inherited from CommonComponentTableT.) |
| FindIndex |
Retrieves a Group object based on Index. This seach type of search is discouraged.
We are moving towards using only IDs for all tables.
|
| FindName |
Finds a Linetype given its name. Returns the instance, rather than the index.
|
| FindNameHash |
Finds a Linetype 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 | |
| GroupNames | |
| GroupObjectCount | |
| Hide | |
| IsDeleted | |
| Lock | |
| Show | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Undelete | |
| Unlock |
Version InformationRhino for Mac
Supported in: 5.4Rhino for Windows
Supported in: 6.14See Also