|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ ConditionControl() [1/2]
Initializes a control tied to the segment in_seg.
◆ ConditionControl() [2/2]
Initializes a control tied to the same object as in_that.
◆ AddCondition()
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.
◆ GetCount()
ulong HPS.ConditionControl.GetCount |
( |
| ) |
|
|
inline |
Retrieves the number of conditions set on this segment.
- Returns
- The number of conditions set on this segment.
◆ ObjectType()
override HPS.Type HPS.ConditionControl.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.Object.
◆ SetCondition()
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.
◆ SetConditions()
Sets a collection of conditions as the only active conditions on this segment, replacing any existing conditions.
- Parameters
-
in_conditions | An array of conditions to enable. |
- Returns
- a reference to this object.
◆ ShowCondition()
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.
◆ Type()
override HPS.Type HPS.ConditionControl.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.Object.
◆ UnsetCondition()
Removes a specified condition from the active conditions on this segment.
- Parameters
-
in_condition | The condition to remove. |
- Returns
- a reference to this object.
◆ UnsetEverything()
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