LineAttributeControl

class HPS.LineAttributeControl : public HPS.Control 

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.

Public Functions

override void Dispose ()

LineAttributeControl (HPS.LineAttributeControl in_that): Initializes a control tied to the same object as in_that.

LineAttributeControl (HPS.SegmentKey in_seg): Initializes a control tied to the segment in_seg.

override HPS.Type ObjectType ()

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).

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

HPS.LineAttributeControl SetPattern (string in_pattern)

Specifies the pattern of lines.

See: Programming Guide: Line Patterns

Param in_pattern: The name of a line pattern, defined in a portfolio that is accessible.
Return: A reference to this object.

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

Specifies the pattern of lines.

See: Programming Guide: Line Patterns

Param in_pattern: The name of a line pattern, defined in a portfolio that is accessible.
Param in_options: A set of options that modify how the named line pattern is applied.
Return: A reference to this object.

HPS.LineAttributeControl SetWeight (float in_weight)

Sets the weight of lines.

Param in_weight: The weight value for lines.
Return: A reference to this object.

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

Sets the weight of lines.

Param in_weight: The weight value for lines.
Param in_units: The units applied to in_weight.
Return: A reference to this object.

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

Shows the pattern used to draw lines.

Param out_pattern: The name of a line pattern, defined in a portfolio that is accessible.
Param out_options: A set of options that modify how the named line pattern is applied.
Return: true if the setting is valid, false otherwise.

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

Shows the weight of lines.

Param out_weight: The weight value for lines.
Param out_units: The units applied to in_weight.
Return: true if the setting is valid, false otherwise.

HPS.LineAttributeControl UnsetEverything ()

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().

Return: A reference to this object.

HPS.LineAttributeControl UnsetPattern ()

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().

Return: A reference to this object.

HPS.LineAttributeControl UnsetWeight ()

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().

Return: A reference to this object.