API Search || Global Search
HPS.AnchorShapeElement Class Reference

More...

Inheritance diagram for HPS.AnchorShapeElement:
HPS.ShapeElement HPS.Object

Public Member Functions

 AnchorShapeElement ()
 The default constructor creates an empty AnchorShapeElement object. More...
 
 AnchorShapeElement (HPS.ShapeElement in_that)
 This constructor creates a AnchorShapeElement 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 an anchor shape element. Otherwise the copy will fail and the resulting AnchorShapeElement will be invalid. More...
 
 AnchorShapeElement (HPS.AnchorShapeElement in_that)
 The copy constructor creates a AnchorShapeElementAnchorShapeElement object that contains the same settings as the source AnchorShapeElement. More...
 
 AnchorShapeElement (HPS.ShapePoint in_anchor_point)
 This constructor creates a AnchorShapeElement with the specified anchor point. More...
 
 AnchorShapeElement (HPS.ShapePoint in_anchor_point, HPS.ShapePoint[] in_intermediate_points, bool in_connection)
 This constructor creates a AnchorShapeElement with the specified parameters. More...
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
HPS.AnchorShapeElement SetAnchor (HPS.ShapePoint in_anchor)
 Sets the anchor point for this AnchorShapeElement. More...
 
HPS.AnchorShapeElement SetConnection (bool in_connection)
 Sets the connection setting for this AnchorShapeElement. More...
 
HPS.AnchorShapeElement SetIntermediatePoints (HPS.ShapePoint[] in_intermediate_points)
 Sets the intermediate points for this AnchorShapeElement. More...
 
bool ShowAnchor (out HPS.ShapePoint out_anchor)
 Shows the anchor for this AnchorShapeElement. More...
 
bool ShowConnection (out bool out_connection)
 Shows the connection setting for this AnchorShapeElement. More...
 
bool ShowIntermediatePoints (out HPS.ShapePoint[] out_intermediate_points)
 Shows the intermediate points for this AnchorShapeElement. More...
 
HPS.AnchorShapeElement UnsetConnection ()
 Unsets the connection setting for this AnchorShapeElement. More...
 
HPS.AnchorShapeElement UnsetIntermediatePoints ()
 Unsets the intermediate points for this AnchorShapeElement. More...
 
- Public Member Functions inherited from HPS.ShapeElement
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ShapeElement in_that)
 Check if the source ShapeElement is equivalent to this ShapeElement. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.ShapeElement in_that)
 Copies the source ShapeElement into this ShapeElement. More...
 
HPS.ShapeElement SetDisjointed (bool in_state)
 Sets the disjointed state for this ShapeElement. Two shape elements of the same type are automatically joined together if they appear consecutively in the shape element array. LineShapeElement objects are always disjointed. More...
 
HPS.ShapeElement SetFill (bool in_state)
 Sets the fill mode for this ShapeElement. All shape elements default to being filled, except for Lines which cannot be filled. More...
 
 ShapeElement ()
 The default constructor creates an empty ShapeElement object. More...
 
 ShapeElement (HPS.ShapeElement in_that)
 The copy constructor creates a new ShapeElement object that contains the same settings as the source ShapeElement. More...
 
bool ShowDisjointed (out bool out_state)
 Shows the disjointed state for this ShapeElement. Two shape elements of the same type are automatically joined together if they appear consecutively in the shape element array. LineShapeElement objects are always disjointed. More...
 
bool ShowFill (out bool out_state)
 Shows the fill mode for this ShapeElement. All shape elements default to being filled, except for Lines which cannot be filled. More...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

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 AnchorShapeElement class is a user space object. It is used to define anchor elements to make up shapes for text backgrounds. Anchor points are point to which text leader lines connect. If no anchor elements are defined, all ShapePoints used to construct the shape will be used as anchor points. If at least one anchor point is defined, only explicitly defined anchor points will be used.

Constructor & Destructor Documentation

HPS.AnchorShapeElement.AnchorShapeElement ( )
inline

The default constructor creates an empty AnchorShapeElement object.

HPS.AnchorShapeElement.AnchorShapeElement ( HPS.ShapeElement  in_that)
inline

This constructor creates a AnchorShapeElement 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 an anchor shape element. Otherwise the copy will fail and the resulting AnchorShapeElement will be invalid.

Parameters
in_thatThe source ShapeElement to copy.
HPS.AnchorShapeElement.AnchorShapeElement ( HPS.AnchorShapeElement  in_that)
inline

The copy constructor creates a AnchorShapeElementAnchorShapeElement object that contains the same settings as the source AnchorShapeElement.

Parameters
in_thatThe source CircleShapeElement to copy.
HPS.AnchorShapeElement.AnchorShapeElement ( HPS.ShapePoint  in_anchor_point)
inline

This constructor creates a AnchorShapeElement with the specified anchor point.

Parameters
in_anchor_pointThe anchor point.
HPS.AnchorShapeElement.AnchorShapeElement ( HPS.ShapePoint  in_anchor_point,
HPS.ShapePoint[]  in_intermediate_points,
bool  in_connection 
)
inline

This constructor creates a AnchorShapeElement with the specified parameters.

Parameters
in_anchor_pointThe anchor point.
in_intermediate_pointsIntermediate points between the leader line and the anchor point
in_connectionWhether the first intermediate point is connected to the anchor point by a line.

Member Function Documentation

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

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

HPS.AnchorShapeElement HPS.AnchorShapeElement.SetAnchor ( HPS.ShapePoint  in_anchor)
inline

Sets the anchor point for this AnchorShapeElement.

Parameters
in_anchorThe anchor point.
HPS.AnchorShapeElement HPS.AnchorShapeElement.SetConnection ( bool  in_connection)
inline

Sets the connection setting for this AnchorShapeElement.

Parameters
in_connectionWhether the first intermediate point connects to the anchor point.
HPS.AnchorShapeElement HPS.AnchorShapeElement.SetIntermediatePoints ( HPS.ShapePoint[]  in_intermediate_points)
inline

Sets the intermediate points for this AnchorShapeElement.

Parameters
in_intermediate_pointsThe points between the anchor and the leader line.
bool HPS.AnchorShapeElement.ShowAnchor ( out HPS.ShapePoint  out_anchor)
inline

Shows the anchor for this AnchorShapeElement.

Parameters
out_anchorThe anchor point.
Returns
    true if an anchor point was set, false otherwise.
bool HPS.AnchorShapeElement.ShowConnection ( out bool  out_connection)
inline

Shows the connection setting for this AnchorShapeElement.

Parameters
out_connectionWhether the first intermediate point connects to the anchor point.
Returns
    true if a connection setting was set, false otherwise.
bool HPS.AnchorShapeElement.ShowIntermediatePoints ( out HPS.ShapePoint[]  out_intermediate_points)
inline

Shows the intermediate points for this AnchorShapeElement.

Parameters
out_intermediate_pointsThe points between the anchor point and the leader line.
Returns
    true if intermediate points were set, false otherwise.
HPS.AnchorShapeElement HPS.AnchorShapeElement.UnsetConnection ( )
inline

Unsets the connection setting for this AnchorShapeElement.

HPS.AnchorShapeElement HPS.AnchorShapeElement.UnsetIntermediatePoints ( )
inline

Unsets the intermediate points for this AnchorShapeElement.


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