HPS.LeaderLineClippingElement Class Reference
Inheritance diagram for HPS.LeaderLineClippingElement:
HPS.ShapeElement HPS.Object

Public Member Functions

override void Dispose ()
 
 LeaderLineClippingElement ()
 
 LeaderLineClippingElement (HPS.ShapeElement in_that)
 
 LeaderLineClippingElement (HPS.LeaderLineClippingElement in_that)
 
override HPS.Type ObjectType ()
 
HPS.LeaderLineClippingElement SetShape (HPS.PolygonShapeElement in_shape)
 
HPS.LeaderLineClippingElement SetShape (HPS.EllipseShapeElement in_shape)
 
HPS.LeaderLineClippingElement SetShape (HPS.EllipticalArcShapeElement in_shape)
 
HPS.LeaderLineClippingElement SetShape (HPS.CircleShapeElement in_shape)
 
HPS.LeaderLineClippingElement SetShape (HPS.CircularArcShapeElement in_shape)
 
bool ShowClipShapeType (out HPS.Type out_type)
 
bool ShowShape (out HPS.PolygonShapeElement out_shape)
 
bool ShowShape (out HPS.EllipseShapeElement out_shape)
 
bool ShowShape (out HPS.EllipticalArcShapeElement out_shape)
 
bool ShowShape (out HPS.CircleShapeElement out_shape)
 
bool ShowShape (out HPS.CircularArcShapeElement out_shape)
 
HPS.LeaderLineClippingElement UnSetShape ()
 
- Public Member Functions inherited from HPS.ShapeElement
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ShapeElement in_that)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.ShapeElement in_that)
 
HPS.ShapeElement SetDisjointed (bool in_state)
 
HPS.ShapeElement SetFill (bool in_state)
 
 ShapeElement ()
 
 ShapeElement (HPS.ShapeElement in_that)
 
bool ShowDisjointed (out bool out_state)
 
bool ShowFill (out bool out_state)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.ShapeElement
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.ShapeElement
static bool operator!= (HPS.ShapeElement a, HPS.ShapeElement b)
 
static bool operator== (HPS.ShapeElement a, HPS.ShapeElement b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The LeaderLineClippingElement class is a user space object. It is used to define clipping of leader lines around a text background If LeaderLineClippingElement does not have another ShapeElement set for the clip region, it will use the background shape. If LeaderLineClippingElement has another ShapeElement set for the clip region, it will use that instead

Constructor & Destructor Documentation

◆ LeaderLineClippingElement() [1/3]

HPS.LeaderLineClippingElement.LeaderLineClippingElement ( )
inline

The default constructor creates an empty LeaderLineClippingElement object.

◆ LeaderLineClippingElement() [2/3]

HPS.LeaderLineClippingElement.LeaderLineClippingElement ( HPS.ShapeElement  in_that)
inline

This constructor creates a LeaderLineClippingElement object that contains the same settings as the source ShapeElement. The copy will only be successful if the source shape element is really an upcast of a line clipping shape element. Otherwise the copy will fail and the resulting LeaderLineClippingElement will be invalid.

Parameters
in_thatThe source ShapeElement to copy.

◆ LeaderLineClippingElement() [3/3]

HPS.LeaderLineClippingElement.LeaderLineClippingElement ( HPS.LeaderLineClippingElement  in_that)
inline

The copy constructor creates a new LeaderLineClippingElement object that contains the same settings as the source LeaderLineClippingElement.

Parameters
in_thatThe source LeaderLineClippingElement to copy.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.LeaderLineClippingElement.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

◆ SetShape() [1/5]

HPS.LeaderLineClippingElement HPS.LeaderLineClippingElement.SetShape ( HPS.PolygonShapeElement  in_shape)
inline

Sets the explicit Polygon clip shape for this LeaderLineClippingElement. if no explicit shape is set, the background shape will be used

Parameters
in_shapeThe shape to clip leader lines with.

◆ SetShape() [2/5]

HPS.LeaderLineClippingElement HPS.LeaderLineClippingElement.SetShape ( HPS.EllipseShapeElement  in_shape)
inline

Sets the explicit Ellipse clip shape for this LeaderLineClippingElement. if no explicit shape is set, the background shape will be used

Parameters
in_shapeThe shape to clip leader lines with.

◆ SetShape() [3/5]

HPS.LeaderLineClippingElement HPS.LeaderLineClippingElement.SetShape ( HPS.EllipticalArcShapeElement  in_shape)
inline

Sets the explicit Elliptical Arcclip shape for this LeaderLineClippingElement. if no explicit shape is set, the background shape will be used

Parameters
in_shapeThe shape to clip leader lines with.

◆ SetShape() [4/5]

HPS.LeaderLineClippingElement HPS.LeaderLineClippingElement.SetShape ( HPS.CircleShapeElement  in_shape)
inline

Sets the explicit Circle clip shape for this LeaderLineClippingElement. if no explicit shape is set, the background shape will be used

Parameters
in_shapeThe shape to clip leader lines with.

◆ SetShape() [5/5]

HPS.LeaderLineClippingElement HPS.LeaderLineClippingElement.SetShape ( HPS.CircularArcShapeElement  in_shape)
inline

Sets the explicit Circular Arc clip shape for this LeaderLineClippingElement. if no explicit shape is set, the background shape will be used

Parameters
in_shapeThe shape to clip leader lines with.

◆ ShowShape() [1/5]

bool HPS.LeaderLineClippingElement.ShowShape ( out HPS.PolygonShapeElement  out_shape)
inline

Shows the explicit Polygon clip shape for this LeaderLineClippingElement. If the wrong type is provided, will return false

Parameters
out_shapeThe explicit clip shape.
Returns
true if out_shape was set, false otherwise.

◆ ShowShape() [2/5]

bool HPS.LeaderLineClippingElement.ShowShape ( out HPS.EllipseShapeElement  out_shape)
inline

Shows the explicit Ellipse clip shape for this LeaderLineClippingElement. If the wrong type is provided, will return false

Parameters
out_shapeThe explicit clip shape.
Returns
true if out_shape was set, false otherwise.

◆ ShowShape() [3/5]

bool HPS.LeaderLineClippingElement.ShowShape ( out HPS.EllipticalArcShapeElement  out_shape)
inline

Shows the explicit EllipticalArc clip shape for this LeaderLineClippingElement. If the wrong type is provided, will return false

Parameters
out_shapeThe explicit clip shape.
Returns
true if out_shape was set, false otherwise.

◆ ShowShape() [4/5]

bool HPS.LeaderLineClippingElement.ShowShape ( out HPS.CircleShapeElement  out_shape)
inline

Shows the explicit Circle clip shape for this LeaderLineClippingElement. If the wrong type is provided, will return false

Parameters
out_shapeThe explicit clip shape.
Returns
true if out_shape was set, false otherwise.

◆ ShowShape() [5/5]

bool HPS.LeaderLineClippingElement.ShowShape ( out HPS.CircularArcShapeElement  out_shape)
inline

Shows the explicit Ciruclar Arc clip shape for this LeaderLineClippingElement. If the wrong type is provided, will return false

Parameters
out_shapeThe explicit clip shape.
Returns
true if out_shape was set, false otherwise.

◆ UnSetShape()

HPS.LeaderLineClippingElement HPS.LeaderLineClippingElement.UnSetShape ( )
inline

Unsets the explicit clip shape and returns to the default functionality of clipping around the background shape


The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.LeaderLineClippingElement.cs