GroupTable

GroupTable class

Group tables store the list of groups in a Rhino document.

Inheritence: Rhino.FileIO.CommonComponentTable<T>RhinoDocCommonTable<Group>GroupTable
Derived Classes:

Namespace: Rhino.DocObjects.Tables
GroupTable: references

Properties (5)

ComponentType

Returns the actual component type of a table.

Count

Returns the count of all items, including deleted ones.

Document

Document that owns this table.

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 (28)

Add()

Adds a new empty group to the group table.

Add(IEnumerable<Guid> objectIds)

Adds a new group to the group table with a set of objects.

Add(string groupName, IEnumerable<Guid> objectIds)

Adds a new group to the group table with a set of objects.

Add(string groupName)

Adds a new empty group to the group table.

AddToGroup(int groupIndex, IEnumerable<Guid> objectIds)

Adds a list of objects to an existing group.

AddToGroup(int groupIndex,Guid objectId)

Adds an object to an existing group.

ChangeGroupName(int groupIndex, string newName)

Changes the name of a group.

Clear()

Marks all items as deleted.

Delete(Group item)

Delete(int groupIndex)

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(T item)

Deletes an item. Items that are deleted are still keeping their space, but the 'IsDeleted' flag is checked.

Find(string groupName, bool ignoreDeletedGroups)

Finds a group with a given name.

Find(string groupName)

Finds a group with a given name.

FindId(Guid id)

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.

FindIndex(int index)

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(string name)

Finds a group given its name. Returns the instance, rather than the index.

FindNameHash(NameHash nameHash)

Finds a group given its name hash.

GetEnumerator()

Returns the enumerator that yields all items.

GroupMembers(int groupIndex)

Gets an array of all of the objects in a group.

GroupName(int groupIndex)

Returns the name of a group.

GroupNames(bool ignoreDeletedGroups)

Returns an array of all group names.

GroupObjectCount(int groupIndex)

Returns the number of objects that are members of a group.

Hide(int groupIndex)

Hides all objects that are members of a group.

IsDeleted(int groupIndex)

Verifies a group is deleted.

Lock(int groupIndex)

Locks all objects that are members of a group.

Show(int groupIndex)

Shows, or unhides, all objects that are members of a group.

Undelete(int groupIndex)

Undeletes a previously deleted group.

Unlock(int groupIndex)

Unlocks all objects that are members of a group.

Nothing found