InstanceDefinition Class

InstanceDefinition Class

This is the same as InstanceDefinitionGeometry, but in a Rhino document.
Inheritance Hierarchy
SystemObject
  Rhino.DocObjectsInstanceDefinition

Namespace:  Rhino.DocObjects
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
Copy
public sealed class InstanceDefinition
Public NotInheritable Class InstanceDefinition

The InstanceDefinition type exposes the following members.

Properties
  NameDescription
Public propertyArchiveFileStatus
Returns the archive file status of a linked instance definition.
Public propertyComponentStatus
Gets or sets the component status of the model component.
(Inherited from ModelComponent.)
Public propertyComponentType
Returns InstanceDefinition.
(Overrides InstanceDefinitionGeometryComponentType.)
Public propertyDeletedName
Gets the name of a component that is deleted.
(Inherited from ModelComponent.)
Public propertyDescription
Public propertyDisposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
(Inherited from CommonObject.)
Public propertyHasId
Returns a value indicating whether the component has an ID.
(Inherited from ModelComponent.)
Public propertyHasIndex
Returns a value indicating whether the component has an Index.
(Inherited from ModelComponent.)
Public propertyHasName
Returns a value indicating whether the component has a Name.
(Inherited from ModelComponent.)
Public propertyHasUserData
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.)
Public propertyId
Public propertyIdIsLocked
Returns a value indicating whether the component ID is already locked.
(Inherited from ModelComponent.)
Public propertyIndex
Index of this instance definition in the index definition table.
Public propertyIndexIsLocked
Returns a value indicating whether the component Index is already locked.
(Inherited from ModelComponent.)
Public propertyIsComponentStatusLocked
The component status itself can be locked. This returns an indication.
(Inherited from ModelComponent.)
Public propertyCode exampleIsDeleted
Public propertyIsDocumentControlled
If true this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException.
(Inherited from CommonObject.)
Public propertyCode exampleIsReference
An object from a work session reference model is reference a reference object and cannot be modified. An object is a reference object if, and only if, it is on a reference layer.
Public propertyIsSystemComponent
True if this model component is a system constant.

An incomplete list of system constant model components is below:

  • ON_ModelComponent::Unset

  • ON_InstanceDefinition::Empty

  • ON_Linetype::Unset
  • ON_Linetype::Continuous
  • ON_Linetype::ByLayer
  • ON_Linetype::ByParent

  • ON_Layer::Unset
  • ON_Layer::Default

  • ON_TextStyle::Unset
  • ON_TextStyle::Default
  • ON_TextStyle::ByLayer
  • ON_TextStyle::ByParent

  • ON_DimStyle::Unset
  • ON_DimStyle::Default
  • ON_DimStyle::DefaultInchDecimal
  • ON_DimStyle::DefaultInchFractional
  • ON_DimStyle::DefaultFootInchArchitecture
  • ON_DimStyle::DefaultMillimeterSmall
  • ON_DimStyle::DefaultMillimeterLarge
  • ON_DimStyle::DefaultMillimeterArchitecture
(Inherited from ModelComponent.)
Public propertyIsTenuous
Public propertyIsValid
Tests an object to see if it is valid.
(Inherited from CommonObject.)
Public propertyLayerStyle
Public propertyName
Public propertyNameIsLocked
Returns a value indicating whether the component Name is already locked.
(Inherited from ModelComponent.)
Public propertyObjectCount
Number of objects this definition uses. This counts the objects that are used to define the geometry. This does NOT count the number of references to this instance definition.
Public propertySkipNestedLinkedDefinitions
Controls how much geometry is read when a linked InstanceDefinition is updated.
Public propertySourceArchive
Public propertyUpdateType
Public propertyUrl
The hyperlink URL that is executed when the UrlDescription hyperlink is clicked on in the Insert and Block UI
Public propertyUrlDescription
The URL description displayed as a hyperlink in the Insert and Block UI
Public propertyUserData
List of custom information that is attached to this class.
(Inherited from CommonObject.)
Public propertyUserDictionary
Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use sharable set of information.
(Inherited from CommonObject.)
Top
Methods
  NameDescription
Public methodClearId
Resets the HasId property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodClearIndex
Resets the HasIndex property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodClearName
Resets the HasName property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodCreatePreviewBitmap(DefinedViewportProjection, Size)
Public methodCreatePreviewBitmap(DefinedViewportProjection, DisplayMode, Size)
Public methodCreatePreviewBitmap(DefinedViewportProjection, Size, Boolean)
Public methodCreatePreviewBitmap(DefinedViewportProjection, DisplayMode, Size, Boolean)
Public methodDataCRC
Increments the Cyclic Redundancy Check value by this instance.
(Inherited from ModelComponent.)
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.)
Public methodEnsurePrivateCopy
If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want.
(Inherited from CommonObject.)
Public methodEquals(Object) (Inherited from Object.)
Public methodEquals(Object)
Equality is checked against InstanceDefinition.Id
(Overrides ObjectEquals(Object).)
Public methodGetContainers
Gets a list of all the InstanceDefinitions that contain a reference this InstanceDefinition.
Public methodGetHashCode (Inherited from Object.)
Public methodGetHashCode
Use Id.GetHashCode()
(Overrides ObjectGetHashCode.)
Public methodGetObjectData
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.)
Public methodGetObjectIds
list of object ids in the instance geometry table
(Inherited from InstanceDefinitionGeometry.)
Public methodCode exampleGetObjects
Gets an array with the objects that belong to this instance definition.
Public methodGetReferences
Gets a list of the CRhinoInstanceObjects (inserts) that contains a reference this instance definition.
Public methodGetType (Inherited from Object.)
Public methodInUse
Determines whether the instance definition is referenced.
Public methodIsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
(Inherited from CommonObject.)
Public methodLockId
Locks the component Id property.
(Inherited from ModelComponent.)
Public methodLockIndex
Locks the component Index property.
(Inherited from ModelComponent.)
Public methodLockName
Locks the component Name property.
(Inherited from ModelComponent.)
Public methodObject
returns an object used as part of this definition.
Public methodToString (Inherited from Object.)
Public methodToString
Returns the name of the model component type, and then its name and index.
(Inherited from ModelComponent.)
Public methodUsesDefinition
Determines if this instance definition contains a reference to another instance definition.
Top
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.8
See Also

T:Rhino.DocObjects.InstanceDefinition