The ConditionControl class is a smart pointer that is tied to a database object. This class is used to set and unset conditions on a segment. A condition can be used to control when a style is applied, or to control when an included segment is included.
More...
|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
HandleRef | cptr |
|
HandleRef | scptr |
|
bool | cMemOwn |
|
The ConditionControl class is a smart pointer that is tied to a database object. This class is used to set and unset conditions on a segment. A condition can be used to control when a style is applied, or to control when an included segment is included.
Initializes a control tied to the segment in_seg.
Initializes a control tied to the same object as in_that.
Adds a condition to the collection of active conditions on this segment.
- Parameters
-
in_condition | the condition to enable. |
- Returns
- a reference to this object.
ulong HPS.ConditionControl.GetCount |
( |
| ) |
|
|
inline |
Retrieves the number of conditions set on this segment.
- Returns
- The number of conditions set on this segment.
override HPS.Type HPS.ConditionControl.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.
Sets a condition as the only active condition on this segment, replacing any existing conditions.
- Parameters
-
in_condition | the condition to enable. |
- Returns
- a reference to this object.
Sets a collection of conditions as the only active conditions on this segment, replacing any existing conditions.
- Parameters
-
in_count | the number of conditions in the array. |
in_conditions | An array of conditions to enable. |
- Returns
- a reference to this object.
bool HPS.ConditionControl.ShowCondition |
( |
string |
in_condition | ) |
|
|
inline |
Queries the existence of one condition on this segment.
- Parameters
-
in_condition | The condition in question. |
- Returns
- true if the setting is valid, false otherwise.
bool HPS.ConditionControl.ShowConditions |
( |
out string[] |
out_conditions | ) |
|
|
inline |
Shows all conditions on this segment.
- Parameters
-
out_conditions | An array of conditions that are active on the segment. |
- Returns
- true if any conditions are set, false otherwise.
Removes a specified condition from the active conditions on this segment.
- Parameters
-
in_condition | The condition to remove. |
- Returns
- a reference to this object.
Unsets all conditions on this segment.
- Returns
- a reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ConditionControl.cs