Compound
|
This class is used to identify an object in a
database when the object is referenced via a path of
BlockReferences. The object may reside in the host database, in an
external reference database, or even in another unrelated
database.
Inheritance Hierarchy
SystemObject
SystemMarshalByRefObject
Teigha.RuntimeDisposableWrapper
Teigha.RuntimeRXObject
Teigha.DatabaseServicesCompoundObjectId
SystemMarshalByRefObject
Teigha.RuntimeDisposableWrapper
Teigha.RuntimeRXObject
Teigha.DatabaseServicesCompoundObjectId
Namespace: Teigha.DatabaseServices
Assembly: TD_Mgd (in TD_Mgd.dll) Version: 26.9.0.0
Syntax
The CompoundObjectId type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
CompoundObjectId | Default constructor for the CompoundObjectId class. |
|
|
CompoundObjectId(CompoundObjectId) | Copy constructor for the CompoundObjectId class. Copies the passed compound object ID. |
|
|
CompoundObjectId(ObjectId) | Constructor for the CompoundObjectId class. Creates a compound object ID from the passed object ID. |
|
|
CompoundObjectId(ObjectId, Database) | Constructor for the CompoundObjectId class. Creates a compound object ID from the passed object ID in a given host database. |
|
|
CompoundObjectId(ObjectId, ObjectIdCollection, Database) | Constructor for the CompoundObjectId class. Creates a compound object ID from the passed object ID and a path of BlockReferences. |
Properties
| Name | Description | |
|---|---|---|
|
AutoDelete | Property that indicates whether the object should be
automatically deleted by the Garbage Collector. (Inherited from DisposableWrapper) |
|
|
FullPath | Property that represents a collection of pull paths of BlockReference identifiers appended with the leaf ObjectId. |
|
|
IsDisposed | Property that indicates whether pointer to native code
unmanaged object == IntPtr::Zero. (Inherited from DisposableWrapper) |
|
|
IsEmpty | Property that indicates whether this CompoundObjectId contains no data. |
|
|
IsExternal | Property that indicates whether this CompoundObjectId is from an external drawing. |
|
|
IsSimpleObjectId | Property that indicates whether there is no path, only the leaf ID. |
|
|
LeafId | Property that represents either an ObjectId that resides in the BlockTableRecord that is the last BlockReference in the path references, or just an ObjectId if there is no path. |
|
|
Path | Property that represents a collection of object identifiers forming the BlockReference path. |
|
|
TopId | Property that represents the first ObjectId in the path or the leaf node if there is no path. |
|
|
Transform | Property that represents transformation matrix from the leaf object to the world, concatenating all BlockReference transforms, from most nested one to the top one. |
|
|
UnmanagedObject | Property that represents a pointer to an unmanaged
object. (Inherited from DisposableWrapper) |
Methods
| Name | Description | |
|---|---|---|
|
|
Clone | Creates a *clone* of this object, and returns a pointer to the
*clone*. (Inherited from RXObject) |
|
|
CompareTo | Allows classes to compare class objects. (Inherited from RXObject) |
|
|
CopyFrom | Copies the contents of the specified object into this
object. (Inherited from RXObject) |
|
|
CreateObjRef | (Inherited from MarshalByRefObject) |
|
DeleteUnmanagedObject | (Inherited from RXObject) |
|
|
Dispose | (Inherited from DisposableWrapper) |
|
|
Dispose(Boolean) | (Inherited from DisposableWrapper) |
|
|
DwgInFields | Reads the .dwg file data of this object. |
|
|
DwgOutFields | Writes the .dwg file data of this object. |
|
|
DxfInFields | Reads the .dxf file data of this object. |
|
|
DxfOutFields | Writes the .dxf file data of this object. |
|
|
Equals | Checks objects for equality. (Overrides DisposableWrapperEquals(Object)) |
|
|
Finalize | (Inherited from DisposableWrapper) |
|
|
GetHashCode | Retrieves the object hash code. (Inherited from DisposableWrapper) |
|
|
GetLifetimeService | (Inherited from MarshalByRefObject) |
|
|
GetMetaObject | (Inherited from RXObject) |
|
|
GetRXClass | Gets a class describing instance dynamically associated with
this object as the OdRxClass object. (Inherited from RXObject) |
|
|
GetType | (Inherited from Object) |
|
|
InitializeLifetimeService | (Inherited from MarshalByRefObject) |
|
|
IsValid | Checks whether this compound object ID is valid according to the level of testing. |
|
|
MemberwiseClone | (Inherited from Object) |
|
|
MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject) |
|
NullId | Returns a null compound object ID. |
|
|
QueryX | Checks whether the object belongs to the specified class and
returns a pointer to this object if this object can be converted to
the specified class. (Inherited from RXObject) |
|
|
Remap | Remaps all object identifiers that relate to this compound object ID using the given idMap. |
|
|
Set(CompoundObjectId, Database) | Sets this CompoundObjectId from the passed compound object ID in a given database. |
|
|
Set(ObjectId, Database) | Sets this CompoundObjectId from the passed ObjectId in a given database. |
|
|
Set(ObjectId, ObjectIdCollection, Database) | Sets this CompoundObjectId from the passed object ID and a path of BlockReferences. |
|
|
SetEmpty | Sets this CompoundObjectId to be an empty compound object ID that has no data. |
|
|
SetFullPath | Sets this CompoundObjectId from the object that stores the path of block references. |
|
|
ToString | (Inherited from Object) |
|
|
X | Checks whether the object belongs to the specified class and
returns a pointer to this object if this object can be converted to
the specified class, or throws an exception if it cannot. (Inherited from RXObject) |
Operators
| Name | Description | |
|---|---|---|
|
Assign(CompoundObjectId) | Assignment operator for the CompoundObjectId object. |
|
|
Assign(ObjectId) | Assignment operator for the CompoundObjectId object. |
|
|
Equality(CompoundObjectId) | Equality operator for the CompoundObjectId object. Checks whether the passed object is equal to this object. |
|
|
Inequality(CompoundObjectId) | Inequality operator for the CompoundObjectId object. Checks whether the passed object is not equal to this object. |
See Also