ACadSharp.Objects.Layout

class · ACadSharp · CLR name: ACadSharp.Objects.Layout

Represents a ACadSharp.Objects.Layout object.

Object name F:ACadSharp.DxfFileToken.ObjectLayout. Dxf class name F:ACadSharp.DxfSubclassMarker.Layout.

Base type: ACadSharp.Objects.PlotSettings. Inherited members are documented on their declaring type.

Interfaces: ACadSharp.Classes.IDxfClassDefined, ACadSharp.IHandledCadObject, ACadSharp.INamedCadObject.

import acadsharp
Type = acadsharp.get_type('ACadSharp.Objects.Layout')

Declared public members

Signatures retain CLR types and names. Python.NET resolves overloads and converts compatible Python values at call time. Property setters are shown only when public. Operators retain their CLR names; Python.NET also maps supported operators to Python syntax.

.ctor

ACadSharp.Objects.Layout(System.String name)

Initializes a new instance of the Layout class using the specified name for both the layout's name and display name.

  • name: The name to assign to the layout. This value is used for both the internal name and the display name.

.ctor

ACadSharp.Objects.Layout(System.String name, System.String blockName)

Initializes a new instance of the Layout class with the specified layout name and associated block record name.

  • name: The name to assign to the layout. Cannot be null or empty.
  • blockName: The name of the block record associated with the layout. Cannot be null or empty.

ModelLayoutName

static System.String ModelLayoutName = Model

Represents the name of the model layout used in view rendering.

PaperLayoutName

static System.String PaperLayoutName = Layout1

Specifies the default name for the paper layout used in document generation.

AddViewport

System.Void AddViewport(ACadSharp.Entities.Viewport viewport)

Adds the specified viewport to the collection of entities associated with this block.

  • viewport: The viewport to add to the associated block's entities. Cannot be null.

Clone

ACadSharp.CadObject Clone()

Documentation inherited from: base member.

GetDxfClass

ACadSharp.Classes.DxfClass GetDxfClass()

Documentation inherited from: base member.

ToString

System.String ToString()

Documentation inherited from: base member.

UpdatePaperViewport

System.Void UpdatePaperViewport()

Ensures that the paper ACadSharp.Entities.Viewport exists and updates its dimensions to match the current paper size.

Remarks: If no ACadSharp.Entities.Viewport is associated with the paper space, a new ACadSharp.Entities.Viewport is created and added. This method has no effect if the object is not a paper space.

AssociatedBlock

ACadSharp.Tables.BlockRecord AssociatedBlock { get; }

The associated paper space block table record.

BaseUCS

ACadSharp.Tables.UCS BaseUCS { get; set; }

UCSTableRecord of base UCS if UCS is orthographic (ACadSharp.Objects.Layout.UcsOrthographicType is non-zero).

Remarks: If not present and ACadSharp.Objects.Layout.UcsOrthographicType is non-zero, then base UCS is taken to be WORLD.

Elevation

System.Double Elevation { get; set; }

Layout elevation.

InsertionBasePoint

CSMath.XYZ InsertionBasePoint { get; set; }

Insertion base point for this layout(defined by INSBASE while this layout is current).

IsPaperSpace

System.Boolean IsPaperSpace { get; }

If true, the layout is a paper space.

LastActiveViewport

ACadSharp.Entities.Viewport LastActiveViewport { get; }

Viewport that was last active in this layout when the layout was current.

LayoutFlags

ACadSharp.Objects.LayoutFlags LayoutFlags { get; set; }

Layout flags.

MaxExtents

CSMath.XYZ MaxExtents { get; set; }

Maximum extents for this layout(defined by EXTMAX while this layout is current).

MaxLimits

CSMath.XY MaxLimits { get; set; }

Maximum limits for this layout(defined by LIMMAX while this layout is current).

MinExtents

CSMath.XYZ MinExtents { get; set; }

Minimum extents for this layout(defined by EXTMIN while this layout is current).

MinLimits

CSMath.XY MinLimits { get; set; }

Minimum limits for this layout (defined by LIMMIN while this layout is current).

Name

System.String Name { get; set; }

Layout name.

ObjectName

System.String ObjectName { get; }

Documentation inherited from: base member.

ObjectType

ACadSharp.ObjectType ObjectType { get; }

Documentation inherited from: base member.

Origin

CSMath.XYZ Origin { get; set; }

UCS origin.

PaperViewport

ACadSharp.Entities.Viewport PaperViewport { get; }

Gets the paper viewport associated with this layout. If there are multiple viewports, this property returns the first one found. If no viewports are associated with the layout, this property returns null.

SubclassMarker

System.String SubclassMarker { get; }

Documentation inherited from: base member.

TabOrder

System.Int32 TabOrder { get; set; }

Tab order. This number is an ordinal indicating this layout's ordering in the tab control that is attached to the drawing window. Note that the “Model” tab always appears as the first tab regardless of its tab order.

UCS

ACadSharp.Tables.UCS UCS { get; set; }

UCS Table Record if UCS is a named UCS.

Remarks: If not present, then UCS is unnamed.

UcsOrthographicType

ACadSharp.OrthographicType UcsOrthographicType { get; set; }

Orthographic type of UCS.

Viewports

System.Collections.Generic.IEnumerable[ACadSharp.Entities.Viewport] Viewports { get; }

Gets the collection of viewports associated with this instance.

XAxis

CSMath.XYZ XAxis { get; set; }

UCS X-axis.

YAxis

CSMath.XYZ YAxis { get; set; }

UCS Y-axis.