REFERENCE MANUAL
The ConditionControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
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. 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... | |
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 () |
![]() | |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
HPS.ConditionControl.ConditionControl | ( | HPS.SegmentKey | in_seg | ) |
Initializes a control tied to the segment in_seg.
HPS.ConditionControl.ConditionControl | ( | HPS.ConditionControl | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS.ConditionControl HPS.ConditionControl.AddCondition | ( | string | in_condition | ) |
Adds a condition to the collection of active conditions on this segment.
in_condition | the condition to enable. |
ulong HPS.ConditionControl.GetCount | ( | ) |
Retrieves the number of conditions set on this segment.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
HPS.ConditionControl HPS.ConditionControl.SetCondition | ( | string | in_condition | ) |
Sets a condition as the only active condition on this segment, replacing any existing conditions.
in_condition | the condition to enable. |
HPS.ConditionControl HPS.ConditionControl.SetConditions | ( | string[] | in_conditions | ) |
Sets a collection of conditions as the only active conditions on this segment, replacing any existing conditions.
in_count | the number of conditions in the array. |
in_conditions | An array of conditions to enable. |
bool HPS.ConditionControl.ShowCondition | ( | string | in_condition | ) |
Queries the existence of one condition on this segment.
in_condition | The condition in question. |
bool HPS.ConditionControl.ShowConditions | ( | out string[] | out_conditions | ) |
Shows all conditions on this segment.
out_conditions | An array of conditions that are active on the segment. |
HPS.ConditionControl HPS.ConditionControl.UnsetCondition | ( | string | in_condition | ) |
Removes a specified condition from the active conditions on this segment.
in_condition | The condition to remove. |
HPS.ConditionControl HPS.ConditionControl.UnsetEverything | ( | ) |
Unsets all conditions on this segment.