Field Class
This class represents Field objects in a database. Field objects store the field expression and their evaluated values. Fields can be evaluated by an evaluator to any one of the following data types: Long, Double, String, Date, Point, 3dPoint, ObjectId, Buffer, and Resbuf.
Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    Teigha.RuntimeDisposableWrapper
      Teigha.RuntimeRXObject
        Teigha.GraphicsInterfaceDrawable
          Teigha.DatabaseServicesDBObject
            Teigha.DatabaseServicesField

Namespace: Teigha.DatabaseServices
Assembly: TD_Mgd (in TD_Mgd.dll) Version: 24.2.0.0
Syntax
Copy 
public class Field : DBObject

The Field type exposes the following members.

Constructors
  Name Description
Public method Field Default constructor for the Field class.
Public method Field(String) Constructor for the Field class. Creates a field with the specified field code.
Protected method Field(IntPtr, Boolean) Initializes a new instance of the Field class
Public method Field(String, Boolean) Constructor for the Field class. Creates a field with the specified field code.
Top
Properties
  Name Description
Public property AcadObject
(Inherited from DBObject)
Public property Annotative
(Inherited from DBObject)
Public property AutoDelete
(Inherited from DisposableWrapper)
Public property Bounds
(Inherited from Drawable)
Public property ClassID
(Inherited from DBObject)
Public property Database
(Inherited from DBObject)
Public property DataType Property that represents the data type of the field evaluation result.
Public property Drawable Property that represents a drawable that is associated with this object.
(Inherited from DBObject)
Public property DrawableType
(Inherited from Drawable)
Public property EvaluationOption Property that represents the evaluation options for the field.
Public property EvaluationStatus Property that represents the evaluation status.
Public property EvaluatorId Property that represents the ID of the evaluator used for this field.
Public property ExtensionDictionary
(Inherited from DBObject)
Public property FilingOption Property that represents the filing option for this field.
Public property Format Property that represents the output format for this field.
Public property Handle
(Inherited from DBObject)
Public property HasFields
(Inherited from DBObject)
Public property HasSaveVersionOverride
(Inherited from DBObject)
Public property HyperLink Property that represents a hyperlink associated with this object.
Public property Id Property that represents an object identifier of this database object.
(Inherited from DBObject)
Public property IsAProxy
(Inherited from DBObject)
Public property IsCancelling
(Inherited from DBObject)
Public property IsDisposed
(Inherited from DisposableWrapper)
Public property IsErased
(Inherited from DBObject)
Public property IsEraseStatusToggled
(Inherited from DBObject)
Public property IsModified
(Inherited from DBObject)
Public property IsModifiedGraphics
(Inherited from DBObject)
Public property IsModifiedXData
(Inherited from DBObject)
Public property IsNewObject
(Inherited from DBObject)
Public property IsNotifyEnabled
(Inherited from DBObject)
Public property IsNotifying
(Inherited from DBObject)
Public property IsObjectIdsInFlux
(Inherited from DBObject)
Public property 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.
(Inherited from DBObject)
Public property IsReadEnabled
(Inherited from DBObject)
Public property IsReallyClosing
(Inherited from DBObject)
Public property IsTextField Property that indicates whether this field is a text field with embedded fields.
Public property IsTransactionResident
(Inherited from DBObject)
Public property IsUndoing
(Inherited from DBObject)
Public property IsWriteEnabled
(Inherited from DBObject)
Public property MergeStyle
(Inherited from DBObject)
Public property ObjectBirthVersion
(Inherited from DBObject)
Public property ObjectId
(Inherited from DBObject)
Public property OwnerId
(Inherited from DBObject)
Public property PaperOrientation
(Inherited from DBObject)
Public property State Property that represents a field state by one of the FieldState values or their combination.
Public property UndoFiler
(Inherited from DBObject)
Public property UnmanagedObject
(Inherited from DisposableWrapper)
Public property Value Property that represents a field value in its original data type.
Public property XData
(Inherited from DBObject)
Top
Methods
  Name Description
Public method AddContext Adds a copy of a context to the object.
(Inherited from DBObject)
Public method AddPersistentReactor Adds the specified persistent reactor to this object's reactor list.
(Inherited from DBObject)
Public method ApplyPartialUndo Notification method that is called each time this object uses the partial undo mechanism.
(Inherited from DBObject)
Protected method AssertNotifyEnabled
(Inherited from DBObject)
Protected method AssertReadEnabled
(Inherited from DBObject)
Protected method AssertWriteEnabled
(Inherited from DBObject)
Public method Audit Performs an audit operation on this object.
(Inherited from DBObject)
Public method Cancel Obsolete.
Terminates the current open operation. Currently not implemented.
(Inherited from DBObject)
Public method Clone
(Inherited from RXObject)
Public method 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.
(Inherited from DBObject)
Public method 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.
(Inherited from DBObject)
Public method CompareTo
(Inherited from RXObject)
Public method ConvertToTextField Converts the field to a text field. Currently not implemented.
Public method CopyFrom
(Inherited from RXObject)
Public method CreateExtensionDictionary Creates a DbDictionary extension dictionary of this object.
(Inherited from DBObject)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject)
Public method DecomposeForSave Determines the behavior for custom objects when saving to a .dwg file.
(Inherited from DBObject)
Public method DeepClone Performs a deep clone of this object.
(Inherited from DBObject)
Protected method DeleteUnmanagedObject
(Inherited from DBObject)
Public method DisableUndoRecording Controls the undo recording of this object in OdDbDatabase.
(Inherited from DBObject)
Public method Dispose
(Inherited from DisposableWrapper)
Protected method Dispose(Boolean)
(Inherited from DBObject)
Public method DowngradeOpen Downgrades this object from ForWrite to ForRead.
(Inherited from DBObject)
Public method DowngradeToNotify Downgrades this object from ForNotify and ForWrite to having just one open mode - ForNotify. Currently not implemented.
(Inherited from DBObject)
Public method DwgIn Reads the .dwg file format data of this object from the specified file.
(Inherited from DBObject)
Protected method DwgInFields
(Inherited from DBObject)
Public method DwgOut Writes the .dwg file format data of this object to the specified filer.
(Inherited from DBObject)
Protected method DwgOutFields
(Inherited from DBObject)
Public method DxfIn Reads the .dxf file format data of this object from the specified file.
(Inherited from DBObject)
Protected method DxfInFields
(Inherited from DBObject)
Public method DxfOut Writes the .dxf file format data of this object to the specified filer.
(Inherited from DBObject)
Protected method DxfOutFields
(Inherited from DBObject)
Public method Equals
(Inherited from DisposableWrapper)
Public method Erase Marks this object as "erased".
(Inherited from DBObject)
Public method Erase(Boolean) Sets the erased mode of this object.
(Inherited from DBObject)
Public method Evaluate Evaluates a text field.
Public method Evaluate(Int32, Database) Evaluates a text field according to the specified parameters.
Protected method Finalize
(Inherited from DisposableWrapper)
Public method GetChildren Retrieves the child field. If this field is a text field, the child fields are embedded in the text.
Public method GetData Gets data from the field object using a key.
Public method GetEventExtender
(Inherited from DBObject)
Public method GetField Returns the object ID of a "TEXT" field object from the field dictionary.
(Inherited from DBObject)
Public method GetField(String) Returns the object ID of the specified field object (that matches the property name) from the field dictionary.
(Inherited from DBObject)
Public method GetFieldCode Retrieves a field code as a string value.
Public method GetFieldCode(FieldCodeFlags) Retrieves a field code as a string value.
Public method GetFieldCodeWithChildren Retrieves a field code in various forms.
Public method GetFieldCodeWithChildren(FieldCodeFlags) Retrieves a field code in various forms.
Public method GetHashCode
(Inherited from DisposableWrapper)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Public method GetObjectSaveVersion(DwgFiler) Returns the drawing and maintenance release version into which this object must be stored.
(Inherited from DBObject)
Public method GetObjectSaveVersion(DxfFiler) Returns the drawing and maintenance release version into which this object must be stored.
(Inherited from DBObject)
Public method GetPersistentReactorIds Returns the object IDs of this object's persistent reactors.
(Inherited from DBObject)
Public method GetReactors Obsolete.
Returns this object's transient reactors.
(Inherited from DBObject)
Public method GetRXClass
(Inherited from RXObject)
Public method GetStringValue Retrieves a string value associated with this field.
Public method GetTransientReactors Returns this object's transient reactors.
(Inherited from DBObject)
Public method GetType Gets the Type of the current instance.
(Inherited from Object)
Public method GetXDataForApplication Returns a linked list of ResBufs containing a copy of the XData of this object.
(Inherited from DBObject)
Public method 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.
(Inherited from DBObject)
Public method HasContext Checks whether the specified context exists in the collection.
(Inherited from DBObject)
Public method HasPersistentReactor Checks whether the passed identifier is an identifier of a reactor attached to this object.
(Inherited from DBObject)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Protected method MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
Public method QueryX
(Inherited from RXObject)
Public method RegenSupportFlags
(Inherited from Drawable)
Public method ReleaseExtensionDictionary Releases and erases this object's extension dictionary if it exists and is empty.
(Inherited from DBObject)
Public method RemoveContext Removes a context from the collection. An active context can't be removed.
(Inherited from DBObject)
Public method RemoveField Removes the text field and returns its field ID.
(Inherited from DBObject)
Public method RemoveField(ObjectId) Removes the specified field.
(Inherited from DBObject)
Public method RemoveField(String) Removes the specified field by its name and returns its ID.
(Inherited from DBObject)
Public method RemovePersistentReactor Removes the specified persistent reactor from this object's reactor list.
(Inherited from DBObject)
Public method ResetScaleDependentProperties Resets object properties that depend on scale to the default values.
(Inherited from DBObject)
Public method SetAttributes Sets the vectorization attributes of this object, and returns its attribute flags.
(Inherited from Drawable)
Public method SetData(String, Object) Sets data in the field object with the specified key.
Public method SetData(String, Object, Boolean) Sets data in the field object with the specified key.
Public method SetField(Field) Sets the specified field for the "TEXT" property.
(Inherited from DBObject)
Public method SetField(String, Field) Sets the specified field for the specified property.
(Inherited from DBObject)
Public method SetFieldCode Sets the field code.
Public method SetFieldCodeWithChildren(FieldCodeWithChildren) Sets a group of nested (child) fields and field code for this and nested fields.
Public method SetFieldCodeWithChildren(FieldCodeFlags, FieldCodeWithChildren) Sets a group of nested (child) fields and field code for this and nested fields.
Public method SetFromStyle Sets the annotative property of an object according to its corresponding style, such as styles of text objects.
(Inherited from DBObject)
Public method SetObjectIdsInFlux Called on a newly created cloned object to indicate that its object ID is not valid.
(Inherited from DBObject)
Public method SetPaperOrientation Sets the paper orientation property of a specified object.
(Inherited from DBObject)
Protected method SubRegenSupportFlags
(Inherited from Drawable)
Protected method SubSetAttributes
(Inherited from DBObject)
Protected method SubViewportDraw
(Inherited from DBObject)
Protected method SubViewportDrawLogicalFlags
(Inherited from DBObject)
Protected method SubWorldDraw
(Inherited from DBObject)
Public method 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.
(Inherited from DBObject)
Public method SwapIdWith Swaps the objectIDs, handles, extended data (XData), and extension dictionary between this object and another object.
(Inherited from DBObject)
Public method 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.
(Inherited from DBObject)
Public method ToString Returns a string that represents the current object.
(Inherited from Object)
Public method 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.
(Inherited from DBObject)
Public method UpgradeOpen
(Inherited from DBObject)
Public method ViewportDraw Creates a viewport-dependent geometric representation of this object.
(Inherited from Drawable)
Public method ViewportDrawLogicalFlags Retrieves the setAttributes flags for the current viewportDraw.
(Inherited from Drawable)
Public method WblockClone Performs a shallow clone of this object.
(Inherited from DBObject)
Public method WorldDraw Creates a viewport-independent geometric representation of this object.
(Inherited from Drawable)
Public method X
(Inherited from RXObject)
Public method XDataTransformBy Applies the 3D transformation matrix to the XData of this object.
(Inherited from DBObject)
Top
Events
  Name Description
Public event Cancelled
(Inherited from DBObject)
Public event Copied Notification event called whenever the notifying object has had its clone() member function called.
(Inherited from DBObject)
Public event Erased Notification event called whenever an object has been erased or unerased.
(Inherited from DBObject)
Public event Goodbye Notification event called just before an object is deleted from memory.
(Inherited from DBObject)
Public event 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.
(Inherited from DBObject)
Public event ModifiedXData Notification event called whenever the XData has been written to the notifying object.
(Inherited from DBObject)
Public event ModifyUndone Notification event called whenever the notifying object is currently performing an undo operation that is undoing modifications.
(Inherited from DBObject)
Public event ObjectClosed Notification event called immediately before an object is closed.
(Inherited from DBObject)
Public event OpenedForModify Notification event called whenever an object is opened for modifying ForWrite.
(Inherited from DBObject)
Public event Reappended Notification event called whenever a redo process processes the reappending of the notifying object to the database.
(Inherited from DBObject)
Public event SubObjectModified
(Inherited from DBObject)
Public event Unappended Notification event called whenever the undo process processes the appending of the notifying object to the database.
(Inherited from DBObject)
Top
See Also
©  Bricsys NV. All rights reserved.