AcadPViewport

A window that displays all or a portion of a drawing's paperspace.

Supported Platforms: Windows only

Object Inheritance

IAcadPViewport

↓

IAcadEntity

↓

IAcadObject

↓

IDispatch

Members

These members are part of this object:

Methods

GetXData
SetXData
Delete
GetExtensionDictionary
ArrayPolar
ArrayRectangular
Highlight
Copy
Move
Rotate
Rotate3D
Mirror
Mirror3D
ScaleEntity
TransformBy
Update
GetBoundingBox
IntersectWith
GetGridSpacing
SetGridSpacing
GetSnapSpacing
SetSnapSpacing
Display
SyncModelView

Properties

Handle
ObjectName
ObjectID
Application
HasExtensionDictionary
OwnerID
Document
TrueColor
Layer
Linetype
LinetypeScale
Visible
PlotStyleName
Lineweight
Hyperlinks
Material
EntityTransparency
Center
Direction
GridOn
Height
Width
ViewportOn
Clipped
DisplayLocked
StandardScale
CustomScale
UCSPerViewport
SnapBasePoint
SnapOn
SnapRotationAngle
UCSIconOn
UCSIconAtOrigin
TwistAngle
LensLength
Target
ArcSmoothness
VisualStyle
ShadePlot
ModelView
SheetView
LabelBlockId
HasSheetView
StandardScale2
LayerPropertyOverrides

Events

GetXData()

Void GetXData([in] BSTR AppName, [out] Pointer Type XDataType, [out] Pointer Type XDataValue)

Returns the extended data (XData) associated with an object.

SetXData()

Void SetXData([in] VARIANT XDataType, [in] VARIANT XDataValue)

Sets the extended data (XData) associated with an object.

Delete()

Void Delete( )

Deletes a specified object.

GetExtensionDictionary()

IAcadDictionary* GetExtensionDictionary( )

Returns the extension dictionary associated with an object.

ArrayPolar()

VARIANT ArrayPolar([in] Int NumberOfObjects, [in] Double AngleToFill, [in] VARIANT CenterPoint)

Not implemented. Creates an array of selected objects in a polar pattern.

ArrayRectangular()

VARIANT ArrayRectangular([in] Int NumberOfRows, [in] Int NumberOfColumns, [in] Int NumberOfLevels, [in] Double DistBetweenRows, [in] Double DistBetweenCols, [in] Double DistBetweenLevels)

Not implemented. Creates an array of selected objects in a rectangular pattern.

Highlight()

Void Highlight([in] Boolean HighlightFlag)

Not implemented. Highlights or removes highlight from an entity.

Copy()

IDispatch* Copy( )

Copies a specified entity.

Move()

Void Move([in] VARIANT FromPoint, [in] VARIANT ToPoint)

Moves an entity from one point to a second point.

Rotate()

Void Rotate([in] VARIANT BasePoint, [in] Double RotationAngle)

Rotates an entity around a point.

Rotate3D()

Void Rotate3D([in] VARIANT Point1, [in] VARIANT Point2, [in] Double RotationAngle)

Rotates an entity around a line defined by two points, where the direction of the axis if from the first point to the second point.

Mirror()

IDispatch* Mirror([in] VARIANT Point1, [in] VARIANT Point2)

Not implemented. Mirrors an object around a line defined by two points.

Mirror3D()

IDispatch* Mirror3D([in] VARIANT Point1, [in] VARIANT Point2, [in] VARIANT point3)

Not implemented. Mirrors an object around a plane defined by three points.

ScaleEntity()

Void ScaleEntity([in] VARIANT BasePoint, [in] Double ScaleFactor)

Scales an object with respect to a base point and scale factor.

TransformBy()

Void TransformBy([in] VARIANT TransformationMatrix)

Performs the specified transformation on an entity.

Update()

Void Update( )

Not implemented. Updates the display of an entity.

GetBoundingBox()

Void GetBoundingBox([out] Pointer Type MinPoint, [out] Pointer Type MaxPoint)

Returns the minimum and maximum point of an entity's bounding box.

IntersectWith()

VARIANT IntersectWith([in] IDispatch* IntersectObject, AcExtendOptionShort option)

Returns coordinates of intersections with the (input) IntersectObject.

GetGridSpacing()

Void GetGridSpacing([out] Pointer Type XSpacing, [out] Pointer Type YSpacing)

Specifies or returns the grid spacing for a paperspace viewport.

SetGridSpacing()

Void SetGridSpacing([in] Double XSpacing, [in] Double YSpacing)

Specifies or returns the grid spacing for a paperspace viewport.

GetSnapSpacing()

Void GetSnapSpacing([out] Pointer Type XSpacing, [out] Pointer Type YSpacing)

Specifies or returns the snap spacing for a paperspace viewport.

SetSnapSpacing()

Void SetSnapSpacing([in] Double XSpacing, [in] Double YSpacing)

Specifies or returns the snap spacing for a paperspace viewport.

Display()

Void Display([in] Boolean bStatus)

Turns the display of a paperspace viewport on or off.

SyncModelView()

Void SyncModelView( )

Not implemented. Updates the paperspace viewport parameters with the parameters in the associated model view.

Handle [ReadOnly]

BSTR Handle( )

Returns the handle of an object.

ObjectName [ReadOnly]

BSTR ObjectName( )

Returns the TeighaX class name of an object.

ObjectID [ReadOnly]

LONG_PTR ObjectID( )

Returns the object ID of an object.

Application [ReadOnly]

IDispatch* Application( )

Returns the Application object.

HasExtensionDictionary [ReadOnly]

Boolean HasExtensionDictionary( )

Returns whether an object has an associated extension dictionary.

OwnerID [ReadOnly]

LONG_PTR OwnerID( )

Returns the object ID of the parent object.

Document [ReadOnly]

IDispatch* Document( )

Returns the drawing to which an object belongs.

TrueColor

IAcadAcCmColor* TrueColor( )

Specifies or returns the true color of an object.

Layer

BSTR Layer( )

Specifies or returns the current layer of an object.

Linetype

BSTR Linetype( )

Specifies or returns the current linetype of an object.

LinetypeScale

ACAD_NOUNITS LinetypeScale( )

Specifies or returns the linetype scale factor of an object.

Visible

Boolean Visible( )

Specifies or returns the visibility of an object or the application.

PlotStyleName

BSTR PlotStyleName( )

Specifies or returns the plot style name of an object.

Lineweight

ACAD_LWEIGHT Lineweight( )

Specifies or returns the lineweight of an object.

Hyperlinks [ReadOnly]

IAcadHyperlinks* Hyperlinks( )

Assigns a hyperlink to an object and displays the hyperlink name and description (if one is specified).

Material

BSTR Material( )

Specifies or returns the material of an object.

EntityTransparency

BSTR EntityTransparency( )

Specifies the transparency of the object

Center

VARIANT Center( )

Specifies or returns the x, y, and z coordinates of a paperspace viewports's center point.

Direction

VARIANT Direction( )

Specifies or returns the viewing direction fof a paperspace viewport.

GridOn

Boolean GridOn( )

Specifies or returns whether the grid is on for a paperspace viewport.

Height

Double Height( )

Specifies or returns the height of a paperspace viewport.

Width

Double Width( )

Specifies or returns the width of a paperspace viewport.

ViewportOn

Boolean ViewportOn( )

Specifies or returns whether a paperspace viewport is on.

Clipped [ReadOnly]

Boolean Clipped( )

Returns whether a paperspace viewport is clipped.

DisplayLocked

Boolean DisplayLocked( )

Specifies or returns whether a paperspace viewport is locked.

StandardScale

AcViewportScale StandardScale( )

Specifies or returns the standard scale of a paperspace viewport.

CustomScale

Double CustomScale( )

Specifies or returns a custom scale for a paperspace viewport.

UCSPerViewport

Boolean UCSPerViewport( )

Specifies or returns whether the UCS is saved with a paperspace viewport.

SnapBasePoint

VARIANT SnapBasePoint( )

Specifies or returns the snap base point for a paperspace viewport.

SnapOn

Boolean SnapOn( )

Specifies or returns whether the snap is turned on for a paperspace viewport.

SnapRotationAngle

Double SnapRotationAngle( )

Specifies or returns the snap rotation angle of a paperspace viewport relative to the current UCS.

UCSIconOn

Boolean UCSIconOn( )

Specifies or returns whether the UCS icon is turned on for a paperspace viewport.

UCSIconAtOrigin

Boolean UCSIconAtOrigin( )

Specifies or returns whether the UCS icon displays at the origin for a paperspace viewport.

TwistAngle

ACAD_ANGLE TwistAngle( )

Specifies or returns the twist angle, in radians, for a paperspace viewport.

LensLength

Double LensLength( )

Specifies or returns the lens length used in perspective viewing for a paperspace viewport.

Target

VARIANT Target( )

Specifies or returns the target point for a paperspace viewport.

ArcSmoothness

Integer ArcSmoothness( )

Specifies or returns the smoothness of circles, arcs, and ellipses that display in a paperspace viewport.

VisualStyle

Int VisualStyle( )

Specifies or returns the visual style of a paperspace viewport.

ShadePlot

Int ShadePlot( )

Specifies or returns the shade plot mode of a paperspace viewport.

ModelView

IAcadView* ModelView( )

Specifies or returns the model view associated with the paperspace viewport.

SheetView

IAcadView* SheetView( )

Specifies or returns the sheet view associated with the paperspace viewport.

LabelBlockId

LONG_PTR LabelBlockId( )

Specifies or returns the label block ID associated with the paperspace viewport.

HasSheetView [ReadOnly]

Boolean HasSheetView( )

Specifies whether the paperspace viewport is linked to a corresponding sheet view.

StandardScale2

Int StandardScale2( )

Specifies the standard scale for the viewport

LayerPropertyOverrides [ReadOnly]

Boolean LayerPropertyOverrides( )

Specifies whether the viewport has layer property overrides.

HOME / PCAD_DB_X

AcadPViewport

Object Inheritance

Members