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.
	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.
	Clear	Marks all items as deleted. (Inherited from CommonComponentTableT.)
	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.
	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.
	GetEnumerator	(Overrides CommonComponentTableTGetEnumerator.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	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.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

Rhino.DocObjects.Tables Namespace