Click or drag to resize

InstanceDefinition Properties

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 (Overrides InstanceDefinitionGeometryComponentType.)
Public propertyDeletedName
Gets the name of a component that is deleted.
(Inherited from ModelComponent.)
Public propertyDescription
Gets or sets the description of the definition.
(Inherited from InstanceDefinitionGeometry.)
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
Gets or sets the ID of the current instance.
(Inherited from ModelComponent.)
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.
(Overrides ModelComponentIndex.)
Public propertyIndexIsLocked
Returns a value indicating whether the component Index is already locked.
(Inherited from ModelComponent.)
Public propertyInstanceDefinitionModelSerialNumber
When a component is in a model as part of the information required for a linked instance definition, this value identifies the linked instance definition reference model.
(Inherited from ModelComponent.)
Public propertyIsComponentStatusLocked
The component status itself can be locked. This returns an indication.
(Inherited from ModelComponent.)
Public propertyCode exampleIsDeleted
Returns true if this instance definition is deleted. Deleted object are not saved to a file archive.
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
True if this instance definition is from a linked file. It will be saved only if it is referenced by an instance reference object that is in the active geometry list and is being saved. Note that there can be multiple linked instance definitions with references to tenuous instance definitions.
Public propertyIsValid
Tests an object to see if it is valid.
(Inherited from CommonObject.)
Public propertyLayerStyle
Specifies how model components (layers, materials, dimension styles, etc.) from linked instance definition files appear in the active model.
Public propertyModelSerialNumber
A value identifying the model that manages this component.
(Inherited from ModelComponent.)
Public propertyCode exampleName
Gets or sets the name
(Inherited from ModelComponent.)
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 propertyReferenceModelSerialNumber
When a component is in a model for reference, this value identifies the reference model.
(Inherited from ModelComponent.)
Public propertySkipNestedLinkedDefinitions
This property applies when an instance definition is linked. If true, when reading the file that defines the content of the linked instance definition, skip any linked instance definitions found in that file. If false, when reading the file that defines the content of the linked instance definition, recursively load linked instance definitions found in that file.
Public propertySourceArchive
Gets the full file path for linked instance definitions.
Public propertyUnitSystem
Gets the unit system of the instance definition. If the instance definition was imported from another 3dm file, the unit system may differ from that of the document.
Public propertyUpdateType
Public propertyUrl
Gets or sets the URL or hyperlink of the definition.
(Inherited from InstanceDefinitionGeometry.)
Public propertyUrlDescription
Gets or sets the description of the URL or hyperlink of the definition.
(Inherited from InstanceDefinitionGeometry.)
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
See Also