DBObject Class

This class is the base class for all objects contained in a Database instance. An object can be opened in any one of the following modes:

Mode	Description
OpenMode.ForRead	Allows operations that do not modify this object. A database object can be opened in this mode any number of times (simultaneously), if it is not opened in ForWrite or ForNotify mode. An exception is thrown if any type of write operation is attempted on an object opened in this mode.
OpenMode.ForWrite	Allows read and write operations to be performed on this object. The database object can be opened in this mode only if it is not already opened in any mode.
OpenMode.ForNotify	A database object cannot be opened in this mode more than one time simultaneously, but it can be opened in ForNotify mode if it was already opened in ForRead or ForWrite modes, or it was closed before.

Inheritance Hierarchy

Namespace: Teigha.DatabaseServices
Assembly: TD_Mgd (in TD_Mgd.dll) Version: 26.9.0.0

Syntax

C++

public abstract class DBObject : Drawable

Public MustInherit Class DBObject
        Inherits Drawable

public ref class DBObject abstract : public Drawable

[<AbstractClassAttribute>]
type DBObject = 
    class
        inherit Drawable
    end

The DBObject type exposes the following members.

Constructors

	Name	Description
	DBObject	Constructor for the DBObject class.

Top

Properties

	Name	Description
	AcadObject
	Annotative	Property that represents annotative status of an object.
	AutoDelete	Property that indicates whether the object should be automatically deleted by the Garbage Collector. (Inherited from DisposableWrapper)
	Bounds	This property represents bounds of the drawable, if available. This property is null if the drawable does not have bounds or the bounds cannot be computed. (Inherited from Drawable)
	ClassID	Property that represents class ID of an object.
	Database	Property that represents database used by an object.
	Drawable	Property that represents a drawable that is associated with this object.
	DrawableType	This property represents type of the current drawable. (Inherited from Drawable)
	ExtensionDictionary	Property that represents Object ID of this object's extension dictionary. Value of this property is null ID if this object does not have an extension dictionary, or if its extension dictionary has been erased.
	Handle	Property that represents the persistent handle of this database object.
	HasFields	Property that indicates whether this object has fields.
	HasSaveVersionOverride	Property that indicates whether this object has its bit set to override the filer version.
	Id	Property that represents an object identifier of this database object. (Overrides DrawableId)
	IsAProxy	Property that indicates whether this object is a proxy object or entity.
	IsCancelling	Property that indicates whether this object currently performs the Cancel() operation.
	IsDisposed	Property that indicates whether pointer to native code unmanaged object == IntPtr::Zero. (Inherited from DisposableWrapper)
	IsErased	Property that indicates whether this object is marked as erased.
	IsEraseStatusToggled	Property that indicates whether this object's erased status has been toggled since it was opened.
	IsModified	Property that indicates whether this object's assertWriteEnabled() has been called since it was opened.
	IsModifiedGraphics	Property that indicates whether an object derived from Entity has been modified (calls assertWriteEnabled() or calls recordGraphicsModified(true)).
	IsModifiedXData	Property that indicates whether this object's assertWriteEnabled() and setXData() have been called since it was opened.
	IsNewObject	Property that indicates whether this object has not been closed since it was created.
	IsNotifyEnabled	Property that indicates whether this object is open for notifications.
	IsNotifying	Property that indicates whether this object is sending notification.
	IsObjectIdsInFlux	Property that indicates whether this object's Object ID is not valid because the DBObject.subDeepClone or DBObject.subWblockClone() have yet to be completed.
	IsPersistent	Property that indicates whether this object is a database-resident (DBRO). Persistent objects belong to an object that must be opened and closed. Non-persistent objects can be accessed through their pointers. (Overrides DrawableIsPersistent)
	IsReadEnabled	Property that indicates whether this object is open in ForRead mode.
	IsReallyClosing	Property that indicates whether call to close would completely close this object at this time. It is possible only if this object is open in ForRead mode with only one reader, and is not in a transaction.
	IsTransactionResident	Property that indicates whether this object is currently part of transaction.
	IsUndoing	Property that indicates whether this object is currently participating in Undo() operation.
	IsWriteEnabled	Property that indicates whether this object is open in ForWrite mode.
	MergeStyle	Property that represents a merge style that is used when merging duplicate records.
	ObjectBirthVersion	Property that represents birth version of an object. The birth version is the version in which the class was introduced.
	ObjectId	Property that represents an object identifier of this object.
	OwnerId	Property that represents object identifier of this object's owner.
	PaperOrientation	Property that represents paper orientation of an annotative object.
	UndoFiler	Property that represents undo filer associated with this object. This property is typically used by custom classes using partial Undo to add Undo information to the filer that would be used by this object applyPartialUndo().
	UnmanagedObject	Property that represents a pointer to an unmanaged object. (Inherited from DisposableWrapper)
	XData	Property that represents result buffer containing custom data associated with this object.

Top

Methods

	Name	Description
	AddContext	Adds a copy of a context to the object.
	AddPersistentReactor	Adds the specified persistent reactor to this object's reactor list.
	ApplyPartialUndo	Notification method that is called each time this object uses the partial undo mechanism.
	AssertNotifyEnabled
	AssertReadEnabled
	AssertWriteEnabled
	Audit	Performs an audit operation on this object.
	Cancel	Obsolete. Terminates the current open operation. Currently not implemented.
	Clone	Creates a clone of this object, and returns a pointer to the clone. (Inherited from RXObject)
	Close	Obsolete. Closes the object. All changes made to the object since it was opened are committed to the database and a notification is sent that the object is now "closed". Currently not implemented.
	CloseAndPage	Obsolete. Closes the object and pages it if the object pager is enabled. All changes made to the object since it was opened are committed to the database and a notification is sent that the object is now "closed". Currently not implemented.
	CompareTo	Allows classes to compare class objects. (Inherited from RXObject)
	CopyFrom	Copies the contents of the specified object into this object. (Inherited from RXObject)
	CreateExtensionDictionary	Creates a DbDictionary extension dictionary of this object.
	CreateObjRef	(Inherited from MarshalByRefObject)
	DecomposeForSave	Determines the behavior for custom objects when saving to a .dwg file.
	DeepClone	Performs a deep clone of this object.
	DeleteUnmanagedObject	(Overrides RXObjectDeleteUnmanagedObject)
	DisableUndoRecording	Controls the undo recording of this object in OdDbDatabase.
	Dispose	(Inherited from DisposableWrapper)
	Dispose(Boolean)	Releases the unmanaged resources used by the DBObject and optionally releases the managed resources (Overrides DisposableWrapperDispose(Boolean))
	DowngradeOpen	Downgrades this object from ForWrite to ForRead.
	DowngradeToNotify	Downgrades this object from ForNotify and ForWrite to having just one open mode - ForNotify. Currently not implemented.
	DwgIn	Reads the .dwg file format data of this object from the specified file.
	DwgInFields
	DwgOut	Writes the .dwg file format data of this object to the specified filer.
	DwgOutFields
	DxfIn	Reads the .dxf file format data of this object from the specified file.
	DxfInFields
	DxfOut	Writes the .dxf file format data of this object to the specified filer.
	DxfOutFields
	Equals	Checks objects for equality. (Inherited from DisposableWrapper)
	Erase	Marks this object as "erased".
	Erase(Boolean)	Sets the erased mode of this object.
	Finalize	(Inherited from DisposableWrapper)
	FromAcadObject	Returns the ID of an ACAD database object.
	GetBinaryDataForKey	Reads chunks of binary data from this object's extension dictionary.
	GetEventExtender
	GetField	Returns the object ID of a "TEXT" field object from the field dictionary.
	GetField(String)	Returns the object ID of the specified field object (that matches the property name) from the field dictionary.
	GetHashCode	Retrieves the object hash code. (Inherited from DisposableWrapper)
	GetLifetimeService	(Inherited from MarshalByRefObject)
	GetMetaObject	(Inherited from RXObject)
	GetObjectSaveVersion(DwgFiler)	Returns the drawing and maintenance release version into which this object must be stored.
	GetObjectSaveVersion(DxfFiler)	Returns the drawing and maintenance release version into which this object must be stored.
	GetPersistentReactorIds	Returns the object IDs of this object's persistent reactors.
	GetReactors	Obsolete. Returns this object's transient reactors.
	GetRXClass	Gets a class describing instance dynamically associated with this object as the OdRxClass object. (Inherited from RXObject)
	GetTransientReactors	Returns this object's transient reactors.
	GetType	(Inherited from Object)
	GetXDataForApplication	Returns a linked list of ResBufs containing a copy of the XData of this object.
	HandOverTo	Replaces this database-resident (DBRO) object with the specified non-database-resident (NDBRO) object, while retaining this object's objectId, handle, owner, and reactor list.
	HasContext	Checks whether the specified context exists in the collection.
	HasPersistentReactor	Checks whether the passed identifier is an identifier of a reactor attached to this object.
	InitializeLifetimeService	(Inherited from MarshalByRefObject)
	IsCustomObject	Checks whether the passed ID relates to a custom object. Currently not implemented.
	MemberwiseClone	(Inherited from Object)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject)
	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)
	RegenSupportFlags	Retrieves a set of flags that represents the multi-threaded rendering support of this entity. The default is to return the multi-threaded rendering advanced support flags of the entity's registered RxClass. (Inherited from Drawable)
	ReleaseExtensionDictionary	Releases and erases this object's extension dictionary if it exists and is empty.
	RemoveContext	Removes a context from the collection. An active context can't be removed.
	RemoveField	Removes the text field and returns its field ID.
	RemoveField(ObjectId)	Removes the specified field.
	RemoveField(String)	Removes the specified field by its name and returns its ID.
	RemovePersistentReactor	Removes the specified persistent reactor from this object's reactor list.
	ResetScaleDependentProperties	Resets object properties that depend on scale to the default values.
	SetAttributes	Sets the vectorization attributes of this object, and returns its attribute flags. (Inherited from Drawable)
	SetBinaryDataForKey	Copies the binary data in the chunk array into this object's extension dictionary. The data is stored in chunks of 127 butes.
	SetField(Field)	Sets the specified field for the "TEXT" property.
	SetField(String, Field)	Sets the specified field for the specified property.
	SetFromStyle	Sets the annotative property of an object according to its corresponding style, such as styles of text objects.
	SetObjectIdsInFlux	Called on a newly created cloned object to indicate that its object ID is not valid.
	SetPaperOrientation	Sets the paper orientation property of a specified object.
	SubRegenSupportFlags	(Inherited from Drawable)
	SubSetAttributes	Sets the values of the instance's sub-entity traits. (Overrides DrawableSubSetAttributes(DrawableTraits))
	SubViewportDraw	Draws a graphical object that is dependent on the viewport context. (Overrides DrawableSubViewportDraw(ViewportDraw))
	SubViewportDrawLogicalFlags	(Overrides DrawableSubViewportDrawLogicalFlags(ViewportDraw))
	SubWorldDraw	Draws a graphical object that is independent of any viewport context. (Overrides DrawableSubWorldDraw(WorldDraw))
	SupportsCollection	Checks whether a particular context type is supported by this object. This method shows whether an object supports a collection type but does not show whether this object participates in any contexts of that type.
	SwapIdWith	Swaps the objectIDs, handles, extended data (XData), and extension dictionary between this object and another object.
	SwapReferences	This method performs object ID reference translations similar to those done at the end of deep cloning. References between objects in the workset have their object identifiers translated to the swapped object identifiers of the referenced objects. In contrast to cloning, this translation must occur in both directions. Accordingly, it is possible to pass two different ID maps in two different calls to this method. Currently not implemented.
	ToString	(Inherited from Object)
	UpgradeFromNotify	Upgrades the object from at least ForNotify mode to both ForNotify and ForWrite modes. You should place a call to DowngradeToNotify() with no Open() or Close() methods in between. For internal use. Currently not implemented.
	UpgradeOpen
	ViewportDraw	Creates a viewport-dependent geometric representation of this object. (Inherited from Drawable)
	ViewportDrawLogicalFlags	Retrieves the setAttributes flags for the current viewportDraw. (Inherited from Drawable)
	WblockClone	Performs a shallow clone of this object.
	WorldDraw	Creates a viewport-independent geometric representation of this object. (Inherited from Drawable)
	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)
	XDataTransformBy	Applies the 3D transformation matrix to the XData of this object.

Top

Events

	Name	Description
	Cancelled
	Copied	Notification event called whenever the notifying object has had its clone() member function called.
	Erased	Notification event called whenever an object has been erased or unerased.
	Goodbye	Notification event called just before an object is deleted from memory.
	Modified	Notification event called whenever an object is opened ForWrite, a function has been called that could modify the content of this object, and this object is now being closed.
	ModifiedGraphics
	ModifiedXData	Notification event called whenever the XData has been written to the notifying object.
	ModifyUndone	Notification event called whenever the notifying object is currently performing an undo operation that is undoing modifications.
	ObjectClosed	Notification event called immediately before an object is closed.
	OpenedForModify	Notification event called whenever an object is opened for modifying ForWrite.
	Reappended	Notification event called whenever a redo process processes the reappending of the notifying object to the database.
	SubObjectModified
	Unappended	Notification event called whenever the undo process processes the appending of the notifying object to the database.

Top

Extension Methods

	Name	Description
	GetPropertyValue	(Defined by PropertyServiceExtensions)
	SetPropertyValue	(Defined by PropertyServiceExtensions)

Top

Reference

Teigha.DatabaseServices Namespace

Inheritance Hierarchy