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...
|
HPS.ConditionControl | AddCondition (string in_condition) |
| Adds a condition to the collection of active conditions on this segment. More...
|
|
| ConditionControl (HPS.SegmentKey in_seg) |
| Initializes a control tied to the segment in_seg. More...
|
|
| ConditionControl (HPS.ConditionControl in_that) |
| Initializes a control tied to the same object as in_that. More...
|
|
override void | Dispose () |
|
ulong | GetCount () |
| Retrieves the number of conditions set on this segment. More...
|
|
override HPS.Type | ObjectType () |
| This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
|
|
HPS.ConditionControl | SetCondition (string in_condition) |
| Sets a condition as the only active condition on this segment, replacing any existing conditions. More...
|
|
HPS.ConditionControl | SetConditions (string[] in_conditions) |
| Sets a collection of conditions as the only active conditions on this segment, replacing any existing conditions. More...
|
|
bool | ShowCondition (string in_condition) |
| Queries the existence of one condition on this segment. More...
|
|
bool | ShowConditions (out string[] out_conditions) |
| Shows all conditions on this segment. 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.ConditionControl | UnsetCondition (string in_condition) |
| Removes a specified condition from the active conditions on this segment. More...
|
|
HPS.ConditionControl | UnsetEverything () |
| Unsets all conditions on this segment. More...
|
|
| Control (HPS.Control in_that) |
|
override void | Dispose () |
|
override HPS.Type | ObjectType () |
| This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. 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...
|
|
virtual bool | Empty () |
| Indicates whether this object has any values set on it. More...
|
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
| Returns an identifier that can be used to identify which instance of a class an object is. 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 () |
|
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.
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_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.
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Object.
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