HPS.LineAttributeControl Class Reference
Inheritance diagram for HPS.LineAttributeControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
 LineAttributeControl (HPS.SegmentKey in_seg)
 
 LineAttributeControl (HPS.LineAttributeControl in_that)
 
override HPS.Type ObjectType ()
 
HPS.LineAttributeControl SetPattern (string in_pattern)
 
HPS.LineAttributeControl SetPattern (string in_pattern, HPS.LinePatternOptionsKit in_options)
 
HPS.LineAttributeControl SetWeight (float in_weight, HPS.Line.SizeUnits in_units)
 
HPS.LineAttributeControl SetWeight (float in_weight)
 
bool ShowPattern (out string out_pattern, out HPS.LinePatternOptionsKit out_options)
 
bool ShowWeight (out float out_weight, out HPS.Line.SizeUnits out_units)
 
override HPS.Type Type ()
 
HPS.LineAttributeControl UnsetEverything ()
 
HPS.LineAttributeControl UnsetPattern ()
 
HPS.LineAttributeControl UnsetWeight ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- 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 ()
 

Protected Member Functions

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

Additional Inherited Members

- 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 HPS.LineAttributeControl class is a smart pointer that is tied to a database object. This control allows you to manipulate the weight and pattern of lines and polylines.

This table lists default values for the various segment attributes accessible from HPS.LineAttributeControl.

Constructor & Destructor Documentation

◆ LineAttributeControl() [1/2]

HPS.LineAttributeControl.LineAttributeControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ LineAttributeControl() [2/2]

HPS.LineAttributeControl.LineAttributeControl ( HPS.LineAttributeControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.LineAttributeControl.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.Control.

◆ SetPattern() [1/2]

HPS.LineAttributeControl HPS.LineAttributeControl.SetPattern ( string  in_pattern)
inline

Specifies the pattern of lines.

Parameters
in_patternThe name of a line pattern, defined in a portfolio that is accessible.
Returns
A reference to this object.
See also
Programming Guide: Line Patterns

◆ SetPattern() [2/2]

HPS.LineAttributeControl HPS.LineAttributeControl.SetPattern ( string  in_pattern,
HPS.LinePatternOptionsKit  in_options 
)
inline

Specifies the pattern of lines.

Parameters
in_patternThe name of a line pattern, defined in a portfolio that is accessible.
in_optionsA set of options that modify how the named line pattern is applied.
Returns
A reference to this object.
See also
Programming Guide: Line Patterns

◆ SetWeight() [1/2]

HPS.LineAttributeControl HPS.LineAttributeControl.SetWeight ( float  in_weight,
HPS.Line.SizeUnits  in_units 
)
inline

Sets the weight of lines.

Parameters
in_weightThe weight value for lines.
in_unitsThe units applied to in_weight.
Returns
A reference to this object.

◆ SetWeight() [2/2]

HPS.LineAttributeControl HPS.LineAttributeControl.SetWeight ( float  in_weight)
inline

Sets the weight of lines.

Parameters
in_weightThe weight value for lines.
Returns
A reference to this object.

◆ ShowPattern()

bool HPS.LineAttributeControl.ShowPattern ( out string  out_pattern,
out HPS.LinePatternOptionsKit  out_options 
)
inline

Shows the pattern used to draw lines.

Parameters
out_patternThe name of a line pattern, defined in a portfolio that is accessible.
out_optionsA set of options that modify how the named line pattern is applied.
Returns
true if the setting is valid, false otherwise.

◆ ShowWeight()

bool HPS.LineAttributeControl.ShowWeight ( out float  out_weight,
out HPS.Line.SizeUnits  out_units 
)
inline

Shows the weight of lines.

Parameters
out_weightThe weight value for lines.
out_unitsThe units applied to in_weight.
Returns
true if the setting is valid, false otherwise.

◆ Type()

override HPS.Type HPS.LineAttributeControl.Type ( )
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetEverything()

HPS.LineAttributeControl HPS.LineAttributeControl.UnsetEverything ( )
inline

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by LineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetPattern()

HPS.LineAttributeControl HPS.LineAttributeControl.UnsetPattern ( )
inline

Removes the line pattern setting for lines. If the control is attached to a WindowKey this function restores the default value of this setting as specified by LineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetWeight()

HPS.LineAttributeControl HPS.LineAttributeControl.UnsetWeight ( )
inline

Removes the weight setting for lines. If the control is attached to a WindowKey this function restores the default value of this setting as specified by LineAttributeKit.GetDefault().

Returns
A reference to this object.

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