MarkupTable Class

Collection of markups for a document

Inheritance Hierarchy

SystemObject
  Rhino.FileIOCommonComponentTableMarkup
    Rhino.DocObjects.TablesRhinoDocCommonTableMarkup
      Rhino.DocObjects.TablesMarkupTable

Namespace: Rhino.DocObjects.Tables
Assembly: RhinoCommon (in RhinoCommon.dll)

Since: 9.0

Syntax

Copy

public sealed class MarkupTable : RhinoDocCommonTable<Markup>, 
	ICollection<Markup>, IEnumerable<Markup>, IEnumerable

Public NotInheritable Class MarkupTable
	Inherits RhinoDocCommonTable(Of Markup)
	Implements ICollection(Of Markup), IEnumerable(Of Markup), 
	IEnumerable

The MarkupTable type exposes the following members.

Properties

	Name	Description
	ActiveCount	Returns number of markups in the table, excluding deleted markups.
	ActiveIndex	Index of the markup being viewed or edited, or -1 when none is (including while creating a new markup).
	ComponentType	(Overrides CommonComponentTableTComponentType.)
	Count	Returns number of markups in the table, including deleted markups.
	Document	Document that owns this table.
	Item	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.

Top

Methods

	Name	Description
	Add	Adds a new markup with specified definition to the table.
	AddReferenceMarkup	Adds a reference markup that will not be saved in files.
	Cancel	Discards the current markup edit or create session, or stops viewing a markup.
	Clear	Marks all items as deleted. (Inherited from CommonComponentTableT.)
	Create(RhinoView, IEnumerableGeometryBase)	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.
	Create(RhinoView, IEnumerableGeometryBase, IEnumerableObjectAttributes)	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.
	Delete(Markup)	Deletes a markup. (Overrides CommonComponentTableTDelete(T).)
	Delete(IEnumerableInt32, Boolean)	Delete multiple markups.
	Delete(Int32, Boolean)	Deletes a markup.
	Delete(IEnumerableInt32, Boolean, Int32)	Delete multiple markups.
	Duplicate	Duplicates a markup.
	Edit	Starts editing a markup. Its content becomes editable document objects until Save or Cancel.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Find(String)	Finds the markup with a given name.
	Find(Guid, Boolean)	Finds a markup with a matching ID.
	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 CommonComponentTableT.)
	FindIndex	Retrieves a markup based on Index. This type of search is discouraged. We are moving towards using only IDs for all tables.
	FindName	Finds the markup with a given name.
	GetActiveObjectIds	Ids of the document objects in the open markup create or edit session, including a new markup not yet saved to the table.
	GetEnumerator	(Overrides CommonComponentTableTGetEnumerator.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectIds	Ids of the document objects that make up a markup's content. Editable only during Edit(Int32).
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUnusedMarkupName	Gets unused markup name used as default when creating new markups.
	Modify	Modify markup settings.
	Save	Saves the current markup edit or create session, like the on-screen checkmark. Undoable as one step.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	View	Shows a markup in the active view, as the Markups panel does. Ends any current markup session first.

Top

Reference

Rhino.DocObjects.Tables Namespace