More...
|
override void | Dispose () |
|
| LineAttributeControl (HPS.SegmentKey in_seg) |
| Initializes a control tied to the segment in_seg. More...
|
|
| LineAttributeControl (HPS.LineAttributeControl in_that) |
| Initializes a control tied to the same object as in_that. More...
|
|
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). More...
|
|
HPS.LineAttributeControl | SetPattern (string in_pattern) |
| Specifies the pattern of lines. More...
|
|
HPS.LineAttributeControl | SetPattern (string in_pattern, HPS.LinePatternOptionsKit in_options) |
| Specifies the pattern of lines. More...
|
|
HPS.LineAttributeControl | SetWeight (float in_weight, HPS.Line.SizeUnits in_units) |
| Sets the weight of lines. More...
|
|
HPS.LineAttributeControl | SetWeight (float in_weight) |
| Sets the weight of lines. More...
|
|
bool | ShowPattern (out string out_pattern, out HPS.LinePatternOptionsKit out_options) |
| Shows the pattern used to draw lines. More...
|
|
bool | ShowWeight (out float out_weight, out HPS.Line.SizeUnits out_units) |
| Shows the weight of lines. More...
|
|
override 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...
|
|
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(). More...
|
|
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(). More...
|
|
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(). More...
|
|
| Control (HPS.Control in_that) |
|
virtual bool | Empty () |
| Indicates whether this object has any values set on it. More...
|
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
| Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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...
|
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ LineAttributeControl() [1/2]
HPS.LineAttributeControl.LineAttributeControl |
( |
HPS.SegmentKey |
in_seg | ) |
|
|
inline |
Initializes a control tied to the segment in_seg.
◆ LineAttributeControl() [2/2]
Initializes a control tied to the same object as in_that.
◆ 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]
Specifies the pattern of lines.
- Parameters
-
in_pattern | The name of a line pattern, defined in a portfolio that is accessible. |
- Returns
- A reference to this object.
Programming Guide: Line Patterns
◆ SetPattern() [2/2]
Specifies the pattern of lines.
- Parameters
-
in_pattern | The name of a line pattern, defined in a portfolio that is accessible. |
in_options | A set of options that modify how the named line pattern is applied. |
- Returns
- A reference to this object.
Programming Guide: Line Patterns
◆ SetWeight() [1/2]
Sets the weight of lines.
- Parameters
-
in_weight | The weight value for lines. |
in_units | The units applied to in_weight. |
- Returns
- A reference to this object.
◆ SetWeight() [2/2]
Sets the weight of lines.
- Parameters
-
in_weight | The weight value for lines. |
- Returns
- A reference to this object.
◆ ShowPattern()
Shows the pattern used to draw lines.
- Parameters
-
out_pattern | The name of a line pattern, defined in a portfolio that is accessible. |
out_options | A 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_weight | The weight value for lines. |
out_units | The 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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- 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