InstanceDefinition Class

Returns the archive file status of a linked instance definition.

Gets or sets the component status of the model component.

Returns InstanceDefinition.

Gets the name of a component that is deleted.

Gets or sets the description of the definition.

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

Returns a value indicating whether the component has an ID.

Returns a value indicating whether the component has an Index.

Returns a value indicating whether the component has a Name.

Gets true if this class has any custom information attached to it through UserData.

Gets or sets the ID of the current instance.

Returns a value indicating whether the component ID is already locked.

Index of this instance definition in the index definition table.

Returns a value indicating whether the component Index is already locked.

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.

The component status itself can be locked. This returns an indication.

Returns true if this instance definition is deleted. Deleted object are not saved to a file archive.

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.

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.

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

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.

Tests an object to see if it is valid.

Specifies how model components (layers, materials, dimension styles, etc.) from linked instance definition files appear in the active model.

A value identifying the model that manages this component.

Gets or sets the name

Returns a value indicating whether the component Name is already locked.

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.

When a component is in a model for reference, this value identifies the reference model.

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.

Gets the full file path for linked instance definitions.

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.

Gets or sets the URL or hyperlink of the definition.

Gets or sets the description of the URL or hyperlink of the definition.

List of custom information that is attached to this class.

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

Gets the amount of user strings.

Resets the HasId property of the model component to false, if possible.

Resets the HasIndex property of the model component to false, if possible.

Resets the HasName property of the model component to false, if possible.

Creates a wireframe preview bitmap of the instance definition.

Creates a preview bitmap of the instance definition.

Creates a wireframe preview bitmap of the instance definition.

Creates a preview bitmap of the instance definition.

Creates a preview bitmap of the instance definition.

Creates a preview bitmap of the instance definition.

Increments the Cyclic Redundancy Check value by this instance.

Actively reclaims unmanaged resources that this instance uses.

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.

Equality is checked against InstanceDefinition.Id

Gets a list of all the InstanceDefinitions that contain a reference this InstanceDefinition.

Use Id.GetHashCode()

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

list of object ids in the instance geometry table

Gets an array with the objects that belong to this instance definition.

Gets a list of the CRhinoInstanceObjects (inserts) that contains a reference this instance definition.

Gets the Type of the current instance.

Gets user string from this geometry.

Gets a copy of all (user key string, user value string) pairs attached to this geometry.

Determines whether the instance definition is referenced.

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

Locks the component Id property.

Locks the component Index property.

Locks the component Name property.

returns an object used as part of this definition.

Attach a user string (key,value combination) to this geometry.

Create a JSON string representation of this object

Returns the name of the model component type, and then its name and index.

Returns the number of references of this instance definition in the model. Both top-level references and nested instances are included in the count.

Returns the number of references of this instance definition in the model. Both top-level references and nested instances are included in the count.

Determines if this instance definition contains a reference to another instance definition.

Returns true if some object in the instance definition is on the layer with the specified layer index.

Returns true if some object in the instance definition references the linetype with the specified linetype index.