PageView group table

Properties

ActiveCount

#Since v9.0
Returns number of page view groups in the table, excluding deleted page view groups.
public int ActiveCount { get; }

ComponentType

#Since v9.0
public override ModelComponentType ComponentType { get; }

Count

#Since v9.0
Returns number of page view groups in the table, including deleted page view groups.
public override int Count { get; }

Document

#Since v9.0
Document that owns this table.
public RhinoDoc Document { get; }

Indexers

this[]

#Since v9.0
Conceptually, the page view group table is an array of page view groups. The operator[] can be used to get individual page view group. A page view group is either active or deleted and this state is reported by PageViewGroup.IsDeleted.
public PageViewGroup this[
index
Zero-based array index.
] { get; }
Remarks:

Detaching a worksession reference model, or purging a linked instance definition, removes its page view groups but leaves the table slots they occupied empty. The slots cannot be closed up, because table indices are persistent references that objects store. Count spans the empty slots, and they accumulate for the life of the document - one per purge.

An index that lands on an empty slot returns a PageViewGroup that throws DocumentCollectedException on every property access, so code that walks this table by index must expect it. To tell a real page view group from an empty slot, compare the index you asked for with PageViewGroup.Index: an empty slot never reports the index you asked for. Enumerating the table with foreach goes through the document manifest rather than the raw table array, so it does not visit empty slots at all and is the safer way to walk the table. See RH-97389.

Reference to the page view group. Note, this reference may become invalid after Add() is called.

Methods

Add

#Since v9.0
Adds a new page view group to the table. The new page view group will be given a unique name.
public int Add()
Index of new page view group if successful, -1 otherwise.

Add

#Since v9.0
Adds a new page view group to the table, and adds page views to the group. The new page view group will be given a unique name.
public int Add(
groupMembers
An enumeration of page views.
)
Index of new page view group if successful, -1 otherwise.

Add

#Since v9.0
Adds a new page view group to the table, and adds page views to the group.
public int Add(
group,
The page view group to add. The information in the page view group is copied. If group.Name is empty a unique name will be used.
groupMembers
An enumeration of page views.
)
Index of new page view group if successful, -1 otherwise.

Add

#Since v9.0
Adds a new page view group to the table.
public int Add(
group
The page view group to add. The information in the page view group is copied. If group.Name is empty a unique name will be used.
)
Index of new page view group if successful, -1 otherwise.

Clear

Marks all items as deleted.
public void Clear()
inherited fromCommonComponentTable<T>

Delete

#Since v9.0
Deletes a page view group.
public bool Delete(
id,
Id of page view group.
quiet
true to disable any warning or error messages.
)
true if successful, false otherwise.

Delete

#Since v9.0
Deletes a page view group.
public bool Delete(
index,
Zero-based index of page view group.
quiet
true to disable any warning or error messages.
)
true if successful, false otherwise.

Delete

#Since v9.0
Deletes a page view group.
public bool Delete(
group,
PageViewGroup to delete.
quiet
true to disable any warning or error messages.
)
true if successful, false otherwise.

Delete

#Since v9.0
Deletes a page view group.
public override bool Delete(
group
PageViewGroup to delete.
)

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.
public virtual T FindId(
id
ID of model component to search for.
)
inherited fromCommonComponentTable<T>
Reference to the rhino object with the objectId or null if no such object could be found.
FindId

FindIndex

#Since v9.0
Finds a page view group given its index.
public PageViewGroup FindIndex(
index
Zero-based page view group index.
)
An page view group, or null if not found or on error.

FindName

#Since v9.0
Finds a page view group given its name.
public PageViewGroup FindName(
name
The name of the page view group.
)
An page view group, or null if not found or on error.

FindNameHash

#Since v9.0
Finds a page view group given its name hash.
public PageViewGroup FindNameHash(
nameHash
The name hash of the page view group.
)
An page view group, or null if not found or on error.

GetEnumerator

#Since v9.0
public override IEnumerator<PageViewGroup> GetEnumerator()

GetSorted

#Since v9.0
Gets an array of page view group indices that are sorted by the values of PageViewGroup.SortIndex.
public int[] GetSorted()
An array of page view indices.

GetUnusedName

#Since v9.0
Gets an unused page view group name.
public string GetUnusedName()
An unused page view group name

GetUnusedName

#Since v9.0
Gets an unused page view group name.
public string GetUnusedName(
rootName
The name's root or prefix.
)
An unused page view group name

Modify

#Since v9.0
Modifies a page view group.
public bool Modify(
newSettings,
The modified page view group.
id,
Id of page view group to modify.
quiet
)
>true if successful, false otherwise.
ArgumentNullExceptionIf newSetting is null.

Modify

#Since v9.0
Modifies a page view group.
public bool Modify(
newSettings,
The modified page view group.
index,
Zero-based index of page view group to modify.
quiet
true to disable any warning or error messages.
)
>true if successful, false otherwise.
ArgumentNullExceptionIf newSetting is null.
Explicit

ICollection<PageViewGroup>.Add

#Since v9.0

Undelete

#Since v9.0
Undeletes a page view group that has been deleted.
public bool Undelete(
id
Id of page view group.
)
true if successful, false otherwise.

Undelete

#Since v9.0
Undeletes a page view group that has been deleted.
public bool Undelete(
index
Zero-based index of page view group.
)
true if successful, false otherwise.

UndoModify

#Since v9.0
If the page view group has been modified and the modification can be undone, then this will restore the page view group to its previous state.
[CLSCompliant(false)] public bool UndoModify(
id,
Id of page view group.
undoRecordSerialNumber
)
>true if successful, false otherwise.

UndoModify

#Since v9.0
If the page view group has been modified and the modification can be undone, then this will restore the page view group to its previous state.
public bool UndoModify(
id
Id of page view group.
)
>true if successful, false otherwise.

UndoModify

#Since v9.0
If the page view group has been modified and the modification can be undone, then this will restore the page view group to its previous state.
[CLSCompliant(false)] public bool UndoModify(
index,
Zero-based index of page view group.
undoRecordSerialNumber
Undo record serial number.
)
>true if successful, false otherwise.

UndoModify

#Since v9.0
If the page view group has been modified and the modification can be undone, then this will restore the page view group to its previous state.
public bool UndoModify(
index
Zero-based index of page view group.
)
>true if successful, false otherwise.