Layout Class |
This class represents Layout objects in a
database.
Inheritance Hierarchy
SystemObject
SystemMarshalByRefObject
Teigha.RuntimeDisposableWrapper
Teigha.RuntimeRXObject
Teigha.GraphicsInterfaceDrawable
Teigha.DatabaseServicesDBObject
Teigha.DatabaseServicesPlotSettings
Teigha.DatabaseServicesLayout
SystemMarshalByRefObject
Teigha.RuntimeDisposableWrapper
Teigha.RuntimeRXObject
Teigha.GraphicsInterfaceDrawable
Teigha.DatabaseServicesDBObject
Teigha.DatabaseServicesPlotSettings
Teigha.DatabaseServicesLayout
Namespace: Teigha.DatabaseServices
Assembly: TD_Mgd (in TD_Mgd.dll) Version: 24.2.0.0
Syntax
The Layout type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
Layout | Default constructor for the Layout class. |
|
Layout(IntPtr, Boolean) | Initializes a new instance of the Layout class |
Properties
| Name | Description | |
|---|---|---|
|
AcadObject | (Inherited from DBObject) |
|
|
AnnoAllVisible | Property that indicates whether to display all annotative objects, even those that do not support the current annotation scale. |
|
|
Annotative | (Inherited from DBObject) |
|
|
AutoDelete | (Inherited from DisposableWrapper) |
|
|
BlockTableRecordId | Property that represents the object ID of the PaperSpace BlockTableRecord associated with this Layout object. |
|
|
Bounds | (Inherited from Drawable) |
|
|
CanonicalMediaName | Property that represents the canonical media name for the paper
ID of this PlotSettings object. (Inherited from PlotSettings) |
|
|
ClassID | (Inherited from DBObject) |
|
|
CurrentStyleSheet | Property that represents the current style sheet. (Inherited from PlotSettings) |
|
|
CurrentViewportId | Property that represents the object ID of the viewport that was last active in this Layout object. |
|
|
CustomPrintScale | Property that represents the custom print scale for this
PlotSettings object. The custom print scale always reflects the
scale that this PlotSettings object uses to plot. (Inherited from PlotSettings) |
|
|
Database | (Inherited from DBObject) |
|
|
Drawable | Property that represents a drawable that is associated with
this object. (Inherited from DBObject) |
|
|
DrawableType | (Inherited from Drawable) |
|
|
DrawViewportsFirst | Property that indicates whether viewports are to be plotted
before other objects in paper space for this PlotSettings
object. (Inherited from PlotSettings) |
|
|
ExtensionDictionary | (Inherited from DBObject) |
|
|
Extents | Property that represents extents for this Layout object. |
|
|
Handle | (Inherited from DBObject) |
|
|
HasFields | (Inherited from DBObject) |
|
|
HasSaveVersionOverride | (Inherited from DBObject) |
|
|
Id | Property that represents an object identifier of this database
object. (Inherited from DBObject) |
|
|
IsAProxy | (Inherited from DBObject) |
|
|
IsCancelling | (Inherited from DBObject) |
|
|
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) |
|
|
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) |
|
|
IsTransactionResident | (Inherited from DBObject) |
|
|
IsUndoing | (Inherited from DBObject) |
|
|
IsWriteEnabled | (Inherited from DBObject) |
|
|
LayoutName | Property that represents the name of this Layout object. |
|
|
Limits | Property that represents limits for this Layout object. |
|
|
MergeStyle | (Inherited from DBObject) |
|
|
ModelType | Property that indicates whether this PlotSettings object is the
model space type. (Inherited from PlotSettings) |
|
|
ObjectBirthVersion | (Inherited from DBObject) |
|
|
ObjectId | (Inherited from DBObject) |
|
|
OwnerId | (Inherited from DBObject) |
|
|
PaperOrientation | (Inherited from DBObject) |
|
|
PlotAsRaster | Property that indicates whether the output is raster-based when
using shade plot settings of a viewport. (Inherited from PlotSettings) |
|
|
PlotCentered | Property that indicates whether the plot is to be centered for
this PlotSettings object. (Inherited from PlotSettings) |
|
|
PlotConfigurationName | Property that represents the name of the system printer or plot
configuration file for this PlotSettings object. (Inherited from PlotSettings) |
|
|
PlotHidden | Property that indicates whether the hidden line removal
algorithm is to be applied to paper space entities for this
PlotSettings object. (Inherited from PlotSettings) |
|
|
PlotOrigin | Property that represents the plot origin offset for this
PlotSettings object. The plot origin offset is measured with
respect to the plot margin. All distances are represented in
millimeters, regardless of the drawing units. (Inherited from PlotSettings) |
|
|
PlotPaperMargins | Property that represents the margins of the paper for this
PlotSettings object. Margins are measured from their respective
edges to the plot area and are independent of plot rotation. All
distances are represented in millimeters, regardless of the drawing
units. (Inherited from PlotSettings) |
|
|
PlotPaperSize | Property that represents the size of the paper for this
PlotSettings object. Paper size is the physical paper size and
includes margins. All distances are represented in millimeters,
regardless of the drawing units. (Inherited from PlotSettings) |
|
|
PlotPaperUnits | Property that represents the plot paper units used for margins,
offsets, paper size, and drawing units of this PlotSettings
object. (Inherited from PlotSettings) |
|
|
PlotPlotStyles | Property that indicates whether plotstyles are applied for this
PlotSettings object. (Inherited from PlotSettings) |
|
|
PlotRotation | Property that represents the plot rotation for this
PlotSettings object. (Inherited from PlotSettings) |
|
|
PlotSettingsName | Property that represents the name of this PlotSettings
object. (Inherited from PlotSettings) |
|
|
PlotTransparency | Property that indicates whether transparent plotting is enabled
for this object. (Inherited from PlotSettings) |
|
|
PlotType | Property that represents the plot type for this PlotSettings
Object. (Inherited from PlotSettings) |
|
|
PlotViewName | Property that represents the plot view name for this
PlotSettings object. (Inherited from PlotSettings) |
|
|
PlotViewportBorders | Property that indicates whether viewport borders are plotted
for this PlotSettings object. (Inherited from PlotSettings) |
|
|
PlotWindowArea | Property that represents the corners of the plot window area
for this PlotSettings object. The corners define the area to be
plotted if and only if plotType == kWindow. (Inherited from PlotSettings) |
|
|
PlotWireframe | Property that indicates whether the output is vector-based when
using shade plot settings of a viewport. (Inherited from PlotSettings) |
|
|
PrintLineweights | Property that indicates whether lineweights are printed for
this PlotSettings object. (Inherited from PlotSettings) |
|
|
ScaleLineweights | Property that indicates whether lineweights are scaled for this
PlotSettings object. (Inherited from PlotSettings) |
|
|
ShadePlot | Property that represents the shade plot type for this
PlotSettings object. (Inherited from PlotSettings) |
|
|
ShadePlotCustomDpi | Property that represents the custom resolution at which shaded
and vectorized viewports will plot if shadePlotResLevel ==
ShadePlotResLevel.Custom. (Inherited from PlotSettings) |
|
|
ShadePlotId | Property that represents the object ID of the visual style or
render settings object referenced by this object. (Inherited from PlotSettings) |
|
|
ShadePlotResLevel | Property that represents the shade plot resolution level for
this PlotSettings object. (Inherited from PlotSettings) |
|
|
ShowPlotStyles | Property that indicates whether plotstyles display for this
PlotSettings object during layout mode. (Inherited from PlotSettings) |
|
|
StdScale | Property that represents the standard scale, as a floating
point value, for this PlotSettings object. (Inherited from PlotSettings) |
|
|
StdScaleType | Property that represents the standard scale type for this
PlotSettings object. (Inherited from PlotSettings) |
|
|
TabOrder | Property that represents the tab order for this Layout object. |
|
|
TabSelected | Property that indicates whether this layout tab is selected. |
|
|
Thumbnail | Property that represents the thumbnail bitmap associated with this layout object. |
|
|
UndoFiler | (Inherited from DBObject) |
|
|
UnmanagedObject | (Inherited from DisposableWrapper) |
|
|
UseStandardScale | Property that indicates whether this PlotSettings object uses a
standard scale. (Inherited from PlotSettings) |
|
|
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) |
|
|
AddToLayoutDictionary | Adds this Layout object to the layout dictionary in the specified database, and associates this Layout object with the specified PaperSpace BlockTableRecord. |
|
|
AddToPlotSettingsDictionary | Adds this PlotSettings object to the PlotSettings dictionary in
the specified database. (Inherited from PlotSettings) |
|
|
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) |
|
|
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) |
|
|
GetViewports | Returns a collection of object identifiers of all the viewports that exist in the paper space layout. The first ID in the list is the overall paper space viewport. If the returned collection is empty, this layout is model space or has never been switched to (activated). |
|
|
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) |
|
|
Initialize | Initializes a paper space viewport for the layout. |
|
|
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) |
|
|
SetShadePlot | Sets the shade plot type for this PlotSettings object. (Inherited from PlotSettings) |
|
|
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