InstanceDefinition Properties |
The InstanceDefinition type exposes the following members.
Name | Description | |
---|---|---|
![]() | ArchiveFileStatus |
Returns the archive file status of a linked instance definition.
|
![]() | ComponentStatus |
Gets or sets the component status of the model component.
(Inherited from ModelComponent.) |
![]() | ComponentType |
Returns InstanceDefinition.
(Overrides InstanceDefinitionGeometryComponentType.) |
![]() | DeletedName |
Gets the name of a component that is deleted.
(Inherited from ModelComponent.) |
![]() | Description |
Gets or sets the description of the definition.
(Inherited from InstanceDefinitionGeometry.) |
![]() | Disposed |
Indicates if this object has been disposed or the
document it originally belonged to has been disposed.
(Inherited from CommonObject.) |
![]() | HasId |
Returns a value indicating whether the component has an ID.
(Inherited from ModelComponent.) |
![]() | HasIndex |
Returns a value indicating whether the component has an Index.
(Inherited from ModelComponent.) |
![]() | HasName |
Returns a value indicating whether the component has a Name.
(Inherited from ModelComponent.) |
![]() | HasUserData |
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.) |
![]() | Id |
Gets or sets the ID of the current instance.
(Inherited from ModelComponent.) |
![]() | IdIsLocked |
Returns a value indicating whether the component ID is already locked.
(Inherited from ModelComponent.) |
![]() | Index |
Index of this instance definition in the index definition table.
(Overrides ModelComponentIndex.) |
![]() | IndexIsLocked |
Returns a value indicating whether the component Index is already locked.
(Inherited from ModelComponent.) |
![]() | InstanceDefinitionModelSerialNumber |
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.) |
![]() | IsComponentStatusLocked |
The component status itself can be locked. This returns an indication.
(Inherited from ModelComponent.) |
![]() ![]() | IsDeleted | |
![]() | IsDocumentControlled |
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.) |
![]() ![]() | IsReference |
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.
|
![]() | IsSystemComponent |
True if this model component is a system constant.
(Inherited from ModelComponent.)An incomplete list of system constant model components is below:
|
![]() | IsTenuous | |
![]() | IsValid | Tests an object to see if it is valid. (Inherited from CommonObject.) |
![]() | LayerStyle | |
![]() | ModelSerialNumber |
A value identifying the model that manages this component.
(Inherited from ModelComponent.) |
![]() ![]() | Name |
Gets or sets the name
(Inherited from ModelComponent.) |
![]() | NameIsLocked |
Returns a value indicating whether the component Name is already locked.
(Inherited from ModelComponent.) |
![]() | ObjectCount |
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.
|
![]() | ReferenceModelSerialNumber |
When a component is in a model for reference, this value identifies the reference model.
(Inherited from ModelComponent.) |
![]() | SkipNestedLinkedDefinitions |
Controls how much geometry is read when a linked InstanceDefinition is updated.
|
![]() | SourceArchive | |
![]() | UnitSystem |
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.
|
![]() | UpdateType | |
![]() | Url |
Gets or sets the URL or hyperlink of the definition.
(Inherited from InstanceDefinitionGeometry.) |
![]() | UrlDescription |
Gets or sets the description of the URL or hyperlink of the definition.
(Inherited from InstanceDefinitionGeometry.) |
![]() | UserData |
List of custom information that is attached to this class.
(Inherited from CommonObject.) |
![]() | UserDictionary |
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.) |