|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The HPS.UpdateOptionsControl class is a smart pointer that is tied to a database object. It is used to set selection related options on a HPS.WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting.
Default values for the various fields of HPS.UpdateOptionsControl can be found here.
◆ UpdateOptionsControl() [1/2]
HPS.UpdateOptionsControl.UpdateOptionsControl |
( |
HPS.WindowKey |
in_window | ) |
|
|
inline |
This constructor creates a UpdateOptionsControl object which is tied to the specified window.
- Parameters
-
◆ UpdateOptionsControl() [2/2]
◆ ObjectType()
override HPS.Type HPS.UpdateOptionsControl.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.
◆ SetTimeLimit()
◆ SetUpdateType()
◆ ShowTimeLimit()
bool HPS.UpdateOptionsControl.ShowTimeLimit |
( |
out double |
out_time_limit | ) |
|
|
inline |
Shows the time limit from this UpdateOptionsControl.
- Returns
- true if the time limit is valid, false otherwise.
◆ ShowUpdateType()
Shows the type of control from this UpdateOptionsControl.
- Parameters
-
out_type | The type of update. |
- Returns
- true if the type is valid, false otherwise.
◆ Type()
override HPS.Type HPS.UpdateOptionsControl.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()
◆ UnsetTimeLimit()
◆ UnsetUpdateType()
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.UpdateOptionsControl.cs