Collection of markups for a document
Properties
Returns number of markups in the table, excluding deleted markups.
Index of the markup being viewed or edited, or -1 when none is (including while creating a new markup).
Overrides: CommonComponentTable<T>.ComponentType
Returns number of markups in the table, including deleted markups.
Indexers
Conceptually, the markup table is an array of markups. The operator[] can be used to get individual markups. A markup is either active or deleted and this state is reported by Markup.IsDeleted.
Remarks:
Detaching a worksession reference model, or purging a linked instance definition, removes its markups 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 Markup that throws DocumentCollectedException on every property access, so code that walks this table by index must expect it. To tell a real markup from an empty slot, compare the index you asked for with Markup.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.
Parameters:
| index (int) | zero based array index. |
Returns: Reference to the markup. If index is out of range, null is returned. Note this reference may become invalid after AddMarkup() is called.
Methods
Adds a new markup with specified definition to the table.
Parameters:
| markup (Markup) | Definition of new markup. The information in markup is copied. If markup.Name is empty then a unique name of the form "Markup 01" will be automatically created. |
Returns: Index of new markup type or -1 on error.
Adds a reference markup that will not be saved in files.
Parameters:
| markup (Markup) | Definition of new markup. The information in markup is copied. If markup.Name is empty then a unique name of the form "Markup 01" will be automatically created. |
Returns: Index of new markup or -1 on error.
Discards the current markup edit or create session, or stops viewing a markup.
Returns: true if a markup session or view was ended.
Clear
public void Clear()
Marks all items as deleted.
public int Create(RhinoView view, IEnumerable<GeometryBase> geometry, IEnumerable<ObjectAttributes> attributes)
Adds a markup and its content without a markup session, as one undo step. The geometry is added to the document as the markup's content, and the view, captured before it is added, becomes the background. Any geometry type is allowed. It should lie on a plane parallel to the view, as markup tools draw it, but this is not enforced.
Parameters:
| view (RhinoView) | The view the markup is made in. Its viewport is stored with the markup. |
| geometry (IEnumerable<GeometryBase>) | The markup's content. Copies are added to the document. |
| attributes (IEnumerable<ObjectAttributes>) | Attributes for each geometry item, in the same order. May be null, shorter or contain null; those items get the markup HUD's current color and linetype. |
Returns: Index of the new markup, or -1 on failure, including while the document is in markup mode.
Adds a markup and its content without a markup session, as one undo step. The geometry is added to the document as the markup's content, and the view, captured before it is added, becomes the background. Any geometry type is allowed. It should lie on a plane parallel to the view, as markup tools draw it, but this is not enforced.
Parameters:
| view (RhinoView) | The view the markup is made in. Its viewport is stored with the markup. |
| geometry (IEnumerable<GeometryBase>) | The markup's content. Copies are added to the document. |
Returns: Index of the new markup, or -1 on failure, including while the document is in markup mode.
Deletes a markup.
Deletes a markup.
Parameters:
| item (Markup) | The markup to delete. |
Returns: true if successful, false otherwise.
Overrides: CommonComponentTable<T>.Delete
Delete multiple markups.
Parameters:
| markupIndices (IEnumerable<int>) | An enumeration of markup indices. |
| quiet (bool) | If true, no warning message box appears if a markup is in use. |
| deleteWarning (int) | Action to take when multiple delete warnings occur, where: 0 == No to all, 1 == Yes to all, 2 == Ask the user. |
Returns: The number of markups that were deleted.
Delete multiple markups.
Parameters:
| markupIndices (IEnumerable<int>) | An enumeration of markup indices. |
| quiet (bool) | If true, no warning message box appears if a markup is in use. |
Returns: The number of markups that were deleted.
Duplicates a markup.
Parameters:
| index (int) | zero based index of markup to delete. |
Returns: Index of new markup type or -1 on error.
Parameters:
| index (int) | Zero based index of the markup to edit. |
Returns: true if the edit session started.
Finds a markup with a matching ID.
Finds the markup with a given name.
Parameters:
| name (string) | The name of the markup to find. The search ignores case. |
Returns: If the markup was found, the markup index, >=0, is returned. If the markup was not found, -1 is returned.
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.
Retrieves a markup based on Index. This type of search is discouraged. We are moving towards using only IDs for all tables.
Parameters:
| index (int) | The index to search for. |
Returns: A SectionStyle object, or null if none was found.
Finds the markup with a given name.
Parameters:
| name (string) | The name of the markup to find. |
Returns: The markup if found; otherwise null.
Ids of the document objects in the open markup create or edit session, including a new markup not yet saved to the table.
Returns: The object ids; empty when no create or edit session is open.
Overrides: CommonComponentTable<T>.GetEnumerator
Ids of the document objects that make up a markup's content. Editable only during Edit(int).
Parameters:
| index (int) | Zero based index of the markup. |
Returns: The object ids; empty if the index is invalid or the markup has no objects.
Gets unused markup name used as default when creating new markups.
Returns: The unused name.
Modify markup settings.
Saves the current markup edit or create session, like the on-screen checkmark. Undoable as one step.
Returns: true if the markup was saved. false if no edit or create session is active, or saving failed.
Parameters:
| item (Markup) |