GroupTable

Public Class

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

Inheritance Hierarchy

System.Object
Rhino.FileIO.CommonComponentTable. Group.
Rhino.DocObjects.Tables.RhinoDocCommonTable. Group.
Rhino.DocObjects.Tables.GroupTable

Namespace: Rhino.DocObjects.Tables

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public sealed class GroupTable : RhinoDocCommonTable<Group>,
  ICollection<Group>, IEnumerable<Group>, IEnumerable

The GroupTable type exposes the following members.

Properties

Name

Description

---

Public Property

ComponentType

(Overrides

CommonComponentTable.T..ComponentType

.)

---

Public Property

Count

Returns the count of all items, including deleted ones.

(Inherited from CommonComponentTable.T..)

---

Public Property

Document

Document that owns this table.

(Inherited from RhinoDocCommonTable.T..)

---

Public Property

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

---

Public Method
Add.

Adds a new empty group to the group table.

---

Public Method
Code Example
Add(IEnumerable.Guid.)

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

---

Public Method
Add(String)

Adds a new empty group to the group table.

---

Public Method
Add(String, IEnumerable.Guid.)

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

---

Public Method

AddToGroup(Int32, IEnumerable.Guid.)

Adds a list of objects to an existing group.

---

Public Method

AddToGroup(Int32, Guid)

Adds an object to an existing group.

---

Public Method

ChangeGroupName

Changes the name of a group.

---

Public Method

Clear

Marks all items as deleted.

(Inherited from CommonComponentTable.T..)

---

Public Method

Delete(Group)

(Overrides

CommonComponentTable.T..Delete(T)

.)

---

Public Method

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.

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Public Method

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 CommonComponentTable.T..)

---

Public Method

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.

---

Public Method

FindName

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

---

Public Method

FindNameHash

Finds a group given its name hash.

---

Public Method

GetEnumerator

Returns the enumerator that yields all items.

(Inherited from CommonComponentTable.T..)

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method

GroupMembers

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

---

Public Method

GroupName

Returns the name of a group.

---

Public Method

GroupNames

Returns an array of all group names.

---

Public Method

GroupObjectCount

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

---

Public Method

Hide

Hides all objects that are members of a group.

---

Public Method

IsDeleted

Verifies a group is deleted.

---

Public Method

Lock

Locks all objects that are members of a group.

---

Public Method

Show

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

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Public Method

Undelete

Undeletes a previously deleted group.

---

Public Method

Unlock

Unlocks all objects that are members of a group.

---