IAcadUnderlay

Nil

Supported Platforms: Windows only

Object Inheritance

IAcadUnderlay

↓

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
ClipBoundary

Properties

Handle
ObjectName
ObjectID
Application
HasExtensionDictionary
OwnerID
Document
TrueColor
Layer
Linetype
LinetypeScale
Visible
PlotStyleName
Lineweight
Hyperlinks
Material
EntityTransparency
Contrast
Fade
Position
Rotation
Width
Height
UnderlayName
ItemName
Monochrome
AdjustForBackground
ScaleFactor
File
UnderlayVisibility
ClippingEnabled
UnderlayLayerOverrideApplied

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.

ClipBoundary()

Void ClipBoundary([in] VARIANT boundry)

Specifies an area for displaying and printing the underlay.

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 [ReadOnly]

IAcadAcCmColor* TrueColor( )

Specifies or returns the true color of an object.

Layer [ReadOnly]

BSTR Layer( )

Specifies or returns the current layer of an object.

Linetype [ReadOnly]

BSTR Linetype( )

Specifies or returns the current linetype of an object.

LinetypeScale [ReadOnly]

ACAD_NOUNITS LinetypeScale( )

Specifies or returns the linetype scale factor of an object.

Visible [ReadOnly]

Boolean Visible( )

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

PlotStyleName [ReadOnly]

BSTR PlotStyleName( )

Specifies or returns the plot style name of an object.

Lineweight [ReadOnly]

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 [ReadOnly]

BSTR Material( )

Specifies or returns the material of an object.

EntityTransparency [ReadOnly]

BSTR EntityTransparency( )

Specifies the transparency of the object

Contrast [ReadOnly]

Integer Contrast( )

Specifies or returns the contrast of the underlay.

Fade [ReadOnly]

Integer Fade( )

Specifies or returns the fade of the underlay.

Position [ReadOnly]

VARIANT Position( )

Specifies or returns the lower left point of the underlay position.

Rotation [ReadOnly]

ACAD_ANGLE Rotation( )

Specifies or returns the rotation of the underlay.

Width [ReadOnly]

Double Width( )

Specifies or returns the width of the underlay.

Height [ReadOnly]

Double Height( )

Specifies or returns the height of the underlay.

UnderlayName [ReadOnly]

BSTR UnderlayName( )

Specifies or returns the name of the underlay file.

ItemName

Void ItemName( )

Specifies or returns the item name of the underlay file.

Monochrome [ReadOnly]

Boolean Monochrome( )

Specifies or returns whether the underlay displays in monochrome.

AdjustForBackground [ReadOnly]

Boolean AdjustForBackground( )

Specifies or returns whether underlay colors are adjusted according to the background color.

ScaleFactor [ReadOnly]

ACAD_NOUNITS ScaleFactor( )

Specifies or returns the scale factor of the underlay.

File [ReadOnly]

BSTR File( )

Specifies or returns the path to the underlay file.

UnderlayVisibility [ReadOnly]

Boolean UnderlayVisibility( )

Specifies or returns whether underlay displays in the drawing.

ClippingEnabled [ReadOnly]

Boolean ClippingEnabled( )

Specifies or returns whether the clipping boundary of the underlay is turned on.

UnderlayLayerOverrideApplied [ReadOnly]

AcUnderlayLayerOverrideType UnderlayLayerOverrideApplied( )

Specifies or returns whether the layers of a DWF underlay are applied.

HOME / PCAD_DB_X

IAcadUnderlay

Object Inheritance

Members