Viewport
|
This class represents tiled viewport records
in the ViewportTable of a database.
Inheritance Hierarchy
SystemObject
SystemMarshalByRefObject
Teigha.RuntimeDisposableWrapper
Teigha.RuntimeRXObject
Teigha.GraphicsInterfaceDrawable
Teigha.DatabaseServicesDBObject
Teigha.DatabaseServicesSymbolTableRecord
Teigha.DatabaseServicesAbstractViewTableRecord
Teigha.DatabaseServicesViewportTableRecord
SystemMarshalByRefObject
Teigha.RuntimeDisposableWrapper
Teigha.RuntimeRXObject
Teigha.GraphicsInterfaceDrawable
Teigha.DatabaseServicesDBObject
Teigha.DatabaseServicesSymbolTableRecord
Teigha.DatabaseServicesAbstractViewTableRecord
Teigha.DatabaseServicesViewportTableRecord
Namespace: Teigha.DatabaseServices
Assembly: TD_Mgd (in TD_Mgd.dll) Version: 24.2.0.0
Syntax
The ViewportTableRecord type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
ViewportTableRecord | Default constructor for the ViewportTableRecord class. |
|
ViewportTableRecord(IntPtr, Boolean) | Initializes a new instance of the ViewportTableRecord class |
Properties
| Name | Description | |
|---|---|---|
|
AcadObject | (Inherited from DBObject) |
|
|
AmbientLightColor | (Inherited from AbstractViewTableRecord) |
|
|
Annotative | (Inherited from DBObject) |
|
|
AutoDelete | (Inherited from DisposableWrapper) |
|
|
BackClipDistance | (Inherited from AbstractViewTableRecord) |
|
|
BackClipEnabled | (Inherited from AbstractViewTableRecord) |
|
|
Background | (Inherited from AbstractViewTableRecord) |
|
|
Bounds | (Inherited from Drawable) |
|
|
Brightness | (Inherited from AbstractViewTableRecord) |
|
|
CenterPoint | (Inherited from AbstractViewTableRecord) |
|
|
CircleSides | Property that represents the circle zoom percent of this viewport in the range [1..20000]. This property controls the tessellation of curves; higher numbers use more sides for the curve tessellation. |
|
|
ClassID | (Inherited from DBObject) |
|
|
Contrast | (Inherited from AbstractViewTableRecord) |
|
|
Database | (Inherited from DBObject) |
|
|
DefaultLightingOn | (Inherited from AbstractViewTableRecord) |
|
|
DefaultLightingType | (Inherited from AbstractViewTableRecord) |
|
|
Drawable | Property that represents a drawable that is associated with
this object. (Inherited from DBObject) |
|
|
DrawableType | (Inherited from Drawable) |
|
|
Elevation | (Inherited from AbstractViewTableRecord) |
|
|
ExtensionDictionary | (Inherited from DBObject) |
|
|
FastZoomsEnabled | |
|
|
FrontClipAtEye | (Inherited from AbstractViewTableRecord) |
|
|
FrontClipDistance | (Inherited from AbstractViewTableRecord) |
|
|
FrontClipEnabled | (Inherited from AbstractViewTableRecord) |
|
|
GridAdaptive | Property that indicates whether the grid adapts to display fewer or more lines in the viewport than the value specified by the GRIDUNIT setting. An adaptive grid can be useful to avoid issues when a viewport is zoomed out too much and the grid becomes too dense, or on the contrary, when a viewport is zoomed in too much, there can be too few lines to display the grid. |
|
|
GridBoundToLimits | Property that indicates whether a grid is displayed only inside the limits for the WCS and UCS in this viewport. |
|
|
GridEnabled | Property that indicates whether a grid is enabled in this ViewportTableRecord. |
|
|
GridFollow | Property that indicates whether the grid responds to dynamic UCS changes in this viewport. |
|
|
GridIncrements | Property that represents the grid increments of this viewport. |
|
|
GridMajor | Property that represents the number of minor grid lines between each major grid line. |
|
|
GridSubdivisionRestricted | Property that indicates whether grid subdivision is not allowed below the minor grid spacing in this viewport. |
|
|
Handle | (Inherited from DBObject) |
|
|
HasFields | (Inherited from DBObject) |
|
|
HasSaveVersionOverride | (Inherited from DBObject) |
|
|
Height | (Inherited from AbstractViewTableRecord) |
|
|
IconAtOrigin | Property that indicates whether the UCS icon is at the UCS origin for this viewport. |
|
|
IconEnabled | Property that indicates whether the UCS icon display is enabled. |
|
|
Id | Property that represents an object identifier of this database
object. (Inherited from DBObject) |
|
|
IsAProxy | (Inherited from DBObject) |
|
|
IsCancelling | (Inherited from DBObject) |
|
|
IsDependent | Property that indicates whether this record is
XREF-dependent. (Inherited from SymbolTableRecord) |
|
|
IsDisposed | (Inherited from DisposableWrapper) |
|
|
IsErased | (Inherited from DBObject) |
|
|
IsEraseStatusToggled | (Inherited from DBObject) |
|
|
IsModified | (Inherited from DBObject) |
|
|
IsModifiedGraphics | (Inherited from DBObject) |
|
|
IsModifiedXData | (Inherited from DBObject) |
|
|
IsNewObject | (Inherited from DBObject) |
|
|
IsNotifyEnabled | (Inherited from DBObject) |
|
|
IsNotifying | (Inherited from DBObject) |
|
|
IsObjectIdsInFlux | (Inherited from DBObject) |
|
|
IsometricSnapEnabled | Property that indicates whether snap mode is currently set to isometric. |
|
|
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) |
|
|
IsReadEnabled | (Inherited from DBObject) |
|
|
IsReallyClosing | (Inherited from DBObject) |
|
|
IsResolved | Property that indicates whether this record is XREF-dependent
and resolved. (Inherited from SymbolTableRecord) |
|
|
IsTransactionResident | (Inherited from DBObject) |
|
|
IsUndoing | (Inherited from DBObject) |
|
|
IsWriteEnabled | (Inherited from DBObject) |
|
|
LensLength | (Inherited from AbstractViewTableRecord) |
|
|
LowerLeftCorner | Property that represents the lower-left corner of the viewport window. |
|
|
MergeStyle | (Inherited from DBObject) |
|
|
Name | (Inherited from SymbolTableRecord) |
|
|
ObjectBirthVersion | (Inherited from DBObject) |
|
|
ObjectId | (Inherited from DBObject) |
|
|
OwnerId | (Inherited from DBObject) |
|
|
PaperOrientation | (Inherited from DBObject) |
|
|
PerspectiveEnabled | (Inherited from AbstractViewTableRecord) |
|
|
RenderMode | (Inherited from AbstractViewTableRecord) |
|
|
SnapAngle | Property that represents the UCS snap angle of this viewport. |
|
|
SnapBase | Property that represents the UCS snap base point of this viewport. |
|
|
SnapEnabled | Property that indicates whether snap mode is currently enabled in the ViewportTableRecord. |
|
|
SnapIncrements | Property that represents the snap increments of this viewport. |
|
|
SnapPair | Property that represents the the snap IsoPair setting for the ViewportTableRecord. This setting indicates which current isometric plane is used: * 0 - Left isoplane * 1 - Top isoplane * 2 - Right isoplane |
|
|
SunId | (Inherited from AbstractViewTableRecord) |
|
|
Target | (Inherited from AbstractViewTableRecord) |
|
|
Ucs | (Inherited from AbstractViewTableRecord) |
|
|
UcsFollowMode | Property that indicates whether UCS follow mode is on for this viewport. If set, a viewport generates and displays a plan view whenever the UCS changes in the viewport. |
|
|
UcsName | (Inherited from AbstractViewTableRecord) |
|
|
UcsOrthographic | (Inherited from AbstractViewTableRecord) |
|
|
UcsSavedWithViewport | Property that indicates whether to save the UCS with an associated viewport. If true, it also activates associated UCS when a viewport becomes active and vice versa. |
|
|
UndoFiler | (Inherited from DBObject) |
|
|
UnmanagedObject | (Inherited from DisposableWrapper) |
|
|
UpperRightCorner | Property that represents the uppewr-right corner of the viewport window. |
|
|
ViewDirection | (Inherited from AbstractViewTableRecord) |
|
|
ViewOrthographic | (Inherited from AbstractViewTableRecord) |
|
|
ViewTwist | (Inherited from AbstractViewTableRecord) |
|
|
VisualStyleId | (Inherited from AbstractViewTableRecord) |
|
|
Width | (Inherited from AbstractViewTableRecord) |
|
|
XData | (Inherited from DBObject) |
Methods
| Name | Description | |
|---|---|---|
|
|
AddContext | Adds a copy of a context to the object. (Inherited from DBObject) |
|
|
AddPersistentReactor | Adds the specified persistent reactor to this object's reactor
list. (Inherited from DBObject) |
|
|
ApplyPartialUndo | Notification method that is called each time this object uses
the partial undo mechanism. (Inherited from DBObject) |
|
|
AssertNotifyEnabled | (Inherited from DBObject) |
|
|
AssertReadEnabled | (Inherited from DBObject) |
|
|
AssertWriteEnabled | (Inherited from DBObject) |
|
|
Audit | Performs an audit operation on this object. (Inherited from DBObject) |
|
|
Cancel | Obsolete. Terminates the current open operation. Currently not implemented. (Inherited from DBObject) |
|
|
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. (Inherited from DBObject) |
|
|
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) |
|
|
CompareTo | (Inherited from RXObject) |
|
|
CopyFrom | (Inherited from RXObject) |
|
|
CreateExtensionDictionary | Creates a DbDictionary extension dictionary of this
object. (Inherited from DBObject) |
|
|
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) |
|
|
DecomposeForSave | Determines the behavior for custom objects when saving to a
.dwg file. (Inherited from DBObject) |
|
|
DeepClone | Performs a deep clone of this object. (Inherited from DBObject) |
|
|
DeleteUnmanagedObject | (Inherited from DBObject) |
|
|
DisableUndoRecording | Controls the undo recording of this object in
OdDbDatabase. (Inherited from DBObject) |
|
|
Dispose | (Inherited from DisposableWrapper) |
|
|
Dispose(Boolean) | (Inherited from DBObject) |
|
|
DowngradeOpen | Downgrades this object from ForWrite
to ForRead. (Inherited from DBObject) |
|
|
DowngradeToNotify | Downgrades this object from ForNotify
and ForWrite to having just one open mode
- ForNotify. Currently not
implemented. (Inherited from DBObject) |
|
|
DwgIn | Reads the .dwg file format data of this object from the
specified file. (Inherited from DBObject) |
|
|
DwgInFields | (Inherited from DBObject) |
|
|
DwgOut | Writes the .dwg file format data of this object to the
specified filer. (Inherited from DBObject) |
|
|
DwgOutFields | (Inherited from DBObject) |
|
|
DxfIn | Reads the .dxf file format data of this object from the
specified file. (Inherited from DBObject) |
|
|
DxfInFields | (Inherited from DBObject) |
|
|
DxfOut | Writes the .dxf file format data of this object to the
specified filer. (Inherited from DBObject) |
|
|
DxfOutFields | (Inherited from DBObject) |
|
|
Equals | (Inherited from DisposableWrapper) |
|
|
Erase | Marks this object as "erased". (Inherited from DBObject) |
|
|
Erase(Boolean) | Sets the erased mode of this object. (Inherited from DBObject) |
|
|
Finalize | (Inherited from DisposableWrapper) |
|
|
GetEventExtender | (Inherited from DBObject) |
|
|
GetField | Returns the object ID of a "TEXT" field object from the field
dictionary. (Inherited from DBObject) |
|
|
GetField(String) | Returns the object ID of the specified field object (that
matches the property name) from the field dictionary. (Inherited from DBObject) |
|
|
GetHashCode | (Inherited from DisposableWrapper) |
|
|
GetLifetimeService | Retrieves the current lifetime service object that controls the
lifetime policy for this instance. (Inherited from MarshalByRefObject) |
|
|
GetObjectSaveVersion(DwgFiler) | Returns the drawing and maintenance release version into which
this object must be stored. (Inherited from DBObject) |
|
|
GetObjectSaveVersion(DxfFiler) | Returns the drawing and maintenance release version into which
this object must be stored. (Inherited from DBObject) |
|
|
GetPersistentReactorIds | Returns the object IDs of this object's persistent
reactors. (Inherited from DBObject) |
|
|
GetPreviousBackground | Returns the previously set view background. |
|
|
GetReactors | Obsolete. Returns this object's transient reactors. (Inherited from DBObject) |
|
|
GetRXClass | (Inherited from RXObject) |
|
|
GetTransientReactors | Returns this object's transient reactors. (Inherited from DBObject) |
|
|
GetType | Gets the Type of the current
instance. (Inherited from Object) |
|
|
GetXDataForApplication | Returns a linked list of ResBufs containing a copy of the XData
of this object. (Inherited from DBObject) |
|
|
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) |
|
|
HasContext | Checks whether the specified context exists in the
collection. (Inherited from DBObject) |
|
|
HasPersistentReactor | Checks whether the passed identifier is an identifier of a
reactor attached to this object. (Inherited from DBObject) |
|
|
InitializeLifetimeService | Obtains a lifetime service object to control the lifetime
policy for this instance. (Inherited from MarshalByRefObject) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
|
|
MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject
object. (Inherited from MarshalByRefObject) |
|
|
QueryX | (Inherited from RXObject) |
|
|
RegenSupportFlags | (Inherited from Drawable) |
|
|
ReleaseExtensionDictionary | Releases and erases this object's extension dictionary if it
exists and is empty. (Inherited from DBObject) |
|
|
RemoveContext | Removes a context from the collection. An active context can't
be removed. (Inherited from DBObject) |
|
|
RemoveField | Removes the text field and returns its field ID. (Inherited from DBObject) |
|
|
RemoveField(ObjectId) | Removes the specified field. (Inherited from DBObject) |
|
|
RemoveField(String) | Removes the specified field by its name and returns its
ID. (Inherited from DBObject) |
|
|
RemovePersistentReactor | Removes the specified persistent reactor from this object's
reactor list. (Inherited from DBObject) |
|
|
ResetScaleDependentProperties | Resets object properties that depend on scale to the default
values. (Inherited from DBObject) |
|
|
SetAttributes | Sets the vectorization attributes of this object, and returns
its attribute flags. (Inherited from Drawable) |
|
|
SetField(Field) | Sets the specified field for the "TEXT" property. (Inherited from DBObject) |
|
|
SetField(String, Field) | Sets the specified field for the specified property. (Inherited from DBObject) |
|
|
SetFromStyle | Sets the annotative property of an object according to its
corresponding style, such as styles of text objects. (Inherited from DBObject) |
|
|
SetObjectIdsInFlux | Called on a newly created cloned object to indicate that its
object ID is not valid. (Inherited from DBObject) |
|
|
SetPaperOrientation | Sets the paper orientation property of a specified
object. (Inherited from DBObject) |
|
|
SetPreviousBackground | Sets a previous background for this viewport. |
|
|
SetSun | Sets a sun object for this viewport. (Inherited from AbstractViewTableRecord) |
|
|
SetUcs(ObjectId) | Sets the UCS for the view or viewport table record. (Inherited from AbstractViewTableRecord) |
|
|
SetUcs(OrthographicView) | Sets the UCS for the view or viewport table record. The new UCS
is unnamed and set according to the specified orthographic
view. (Inherited from AbstractViewTableRecord) |
|
|
SetUcs(Point3d, Vector3d, Vector3d) | Sets the UCS for the view or viewport table record according to
the origin and x- and y-coordinate axes. (Inherited from AbstractViewTableRecord) |
|
|
SetUcsToWorld | Sets the UCS for the view or viewport table record to the world
UCS. (Inherited from AbstractViewTableRecord) |
|
|
SetViewDirection | Sets the view direction of the view or view table record
according to the specified orthographic view. (Inherited from AbstractViewTableRecord) |
|
|
SubRegenSupportFlags | (Inherited from Drawable) |
|
|
SubSetAttributes | (Inherited from DBObject) |
|
|
SubViewportDraw | (Inherited from DBObject) |
|
|
SubViewportDrawLogicalFlags | (Inherited from DBObject) |
|
|
SubWorldDraw | (Inherited from DBObject) |
|
|
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) |
|
|
SwapIdWith | Swaps the objectIDs, handles, extended data (XData), and
extension dictionary between this object and another object. (Inherited from DBObject) |
|
|
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) |
|
|
ToString | Returns a string that represents the current object. (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. (Inherited from DBObject) |
|
|
UpgradeOpen | (Inherited from DBObject) |
|
|
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. (Inherited from DBObject) |
|
|
WorldDraw | Creates a viewport-independent geometric representation of this
object. (Inherited from Drawable) |
|
|
X | (Inherited from RXObject) |
|
|
XDataTransformBy | Applies the 3D transformation matrix to the XData of this
object. (Inherited from DBObject) |
Events
| Name | Description | |
|---|---|---|
|
Cancelled | (Inherited from DBObject) |
|
|
Copied | Notification event called whenever the notifying object has had
its clone() member function called. (Inherited from DBObject) |
|
|
Erased | Notification event called whenever an object has been erased or
unerased. (Inherited from DBObject) |
|
|
Goodbye | Notification event called just before an object is deleted from
memory. (Inherited from DBObject) |
|
|
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) |
|
|
ModifiedXData | Notification event called whenever the XData has been written
to the notifying object. (Inherited from DBObject) |
|
|
ModifyUndone | Notification event called whenever the notifying object is
currently performing an undo operation that is undoing
modifications. (Inherited from DBObject) |
|
|
ObjectClosed | Notification event called immediately before an object is
closed. (Inherited from DBObject) |
|
|
OpenedForModify | Notification event called whenever an object is opened for
modifying ForWrite. (Inherited from DBObject) |
|
|
Reappended | Notification event called whenever a redo process processes the
reappending of the notifying object to the database. (Inherited from DBObject) |
|
|
SubObjectModified | (Inherited from DBObject) |
|
|
Unappended | Notification event called whenever the undo process processes
the appending of the notifying object to the database. (Inherited from DBObject) |
See Also