Represents a block definition in a File3dm. This is the same as Rhino.DocObjects.InstanceDefinition, but not associated with a RhinoDoc.
Constructors
Initializes a new block definition.
public InstanceDefinitionGeometry()
Properties
ComponentStatus
Gets or sets the component status of the model component.
Overrides: ModelComponent.ComponentType
Gets or sets the description of the definition.
Disposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
HasUserData
Gets true if this class has any custom information attached to it through UserData.
Exceptions:
| InvalidOperationException | When setting the ID failed. This usually happened because the instance ID is already locked. |
IdIsLocked
Returns a value indicating whether the component ID is already locked.
Exceptions:
| InvalidOperationException | When setting the Index failed. This usually happens because the instance Index is already locked. |
IndexIsLocked
Returns a value indicating whether the component Index is already locked.
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.
Remarks: Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.
IsComponentStatusLocked
The component status itself can be locked. This returns an indication.
IsDeleted
true if the component is deleted. Deleted components are kept by the document for undo purposes.
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.
Returns true if this instance definition is linked to an external source archive, that is, if its UpdateType is InstanceDefinitionUpdateType.Linked or InstanceDefinitionUpdateType.LinkedAndEmbedded.
IsReference
Gets a value indicting whether this component is a referenced component. Referenced components are part of referenced documents.
IsSystemComponent
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
Specifies how model components (layers, materials, dimension styles, etc.) from linked instance definition files appear in the active model.
ModelSerialNumber
A value identifying the model that manages this component.
Remarks: If the component is being managed by a model, this value identifies the model. In Rhino, this value is the document runtime serial number. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.
Exceptions:
| InvalidOperationException | When setting the Name failed. This usually happens because the instance Name is already locked. |
NameIsLocked
Returns a value indicating whether the component Name is already locked.
ReferenceModelSerialNumber
When a component is in a model for reference, this value identifies the reference model.
Remarks: Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.
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 source archive path for linked instance definitions relative to the file that contains this definition. Empty if the definition is not linked or no relative path is stored.
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 the relationship between this instance definition's geometry and the source archive that contains the original definition.
Gets or sets the description of the URL or hyperlink of the definition.
UserData
List of custom information that is attached to this class.
UserDictionary
Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.
Methods
ClearId
Resets the HasId property of the model component to false, if possible.
public void ClearId()
Exceptions:
| InvalidOperationException | If the ID is locked. |
ClearIndex
Resets the HasIndex property of the model component to false, if possible.
public void ClearIndex()
Exceptions:
| InvalidOperationException | If the index is locked. |
ClearName
Resets the HasName property of the model component to false, if possible.
public void ClearName()
Exceptions:
| InvalidOperationException | If the name is locked. |
ConstructConstObject
Assigns a parent object and a sub-object index to this.
DataCRC
Increments the Cyclic Redundancy Check value by this instance.
Returns: The updated remainder value.
Deletes all user strings attached to this geometry.
public void DeleteAllUserStrings()
Deletes the user string with the specified key from this geometry.
Returns: True if the user string was deleted or did not exist; otherwise, false.
Dispose
Actively reclaims unmanaged resources that this instance uses.
public void Dispose()
Dispose
For derived class implementers.
This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.
You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.
Also, you must call the base virtual method within your overriding method.
protected virtual void Dispose()
disposing
true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.
EnsurePrivateCopy
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.
public void EnsurePrivateCopy()
GetObjectData
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public virtual void GetObjectData()
info,
The System.Runtime.Serialization.SerializationInfo to populate with data.
context
The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.
Returns the unique identifiers of all objects that are part of this instance definition's geometry table.
Returns: An array of Guid values representing the object IDs in the instance geometry table.
Gets user string from this geometry.
Returns: string associated with the key if successful. null if no key was found.
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
Returns: A new collection.
IsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
Returns: true if this object is valid; false otherwise.
LockId
Locks the component Id property.
public void LockId()
LockIndex
Locks the component Index property.
public void LockIndex()
LockName
Locks the component Name property.
public void LockName()
NonConstOperation
For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.
protected virtual void NonConstOperation()
OnSwitchToNonConst
Is called when a non-constant operation first occurs.
protected virtual void OnSwitchToNonConst()
Attach a user string (key,value combination) to this geometry.
Returns: true on success.
ToJSON
Create a JSON string representation of this object
ToString
Returns the name of the model component type, and then its name and index.
Remarks: This is provided as a visual aid. Do not rely on this for serialization.
Overrides: Object.ToString