GetClippedObject Method (IViewport) Send Feedback
See Also 
ClippedObject[out]
Entity that defines the clipping boundary: Circle, Ellipse, closed PolyLine, Region, or closed Spline.
ObjType[out]

Type of entity that defines the clipping boundary as defined in dsObjectType_e (see Remarks)

Gets the entity that defines the clipping boundary of the Viewport.

Syntax

Visual Basic 
Function GetClippedObject( _
   ByRef ObjType As dsObjectType_e _
) As System.Object
C# 
System.object GetClippedObject( 
   out dsObjectType_e ObjType
)
JavaScript 
GetClippedObject(
) : {
   ObjType : String,
   ClippedObject : dsObject
}
COM native C++ 
HRESULT GetClippedObject( 
   dsObjectType_e* ObjType,
   IDispatch** ClippedObject
) 
C++ 
DSRESULT GetClippedObject( 
   dsObjectType_e* ObjType,
   dsObject** ClippedObject
) 

Parameters

ObjType[out]

Type of entity that defines the clipping boundary as defined in dsObjectType_e (see Remarks)

ClippedObject[out] or Return Value
Entity that defines the clipping boundary: Circle, Ellipse, closed PolyLine, Region, or closed Spline.

Remarks

Before calling this method, call IViewport::GetIsClipped to determine if the Viewport is clipped.

Valid types of entities that can define the Viewport's clipping boundary are:

  • dsObjectType_e.dsCircleType
  • dsObjectType_e.dsEllipseArcType
  • dsObjectType_e.dsPolyLineType
  • dsObjectType_e.dsRegionType
  • dsObjectType_e.dsSplineType
 

See Also

Availability

DraftSight V1R3.0