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