< Home

< Table of Contents

REFERENCE MANUAL

HPS.UpdateOptionsControl Class Reference

The UpdateOptionsControl class is a smart pointer that is tied to a database object. More...

Inheritance diagram for HPS.UpdateOptionsControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
HPS.UpdateOptionsControl SetTimeLimit (double in_time_limit)
 Sets the time limit of this UpdateOptionsControl. More...
 
HPS.UpdateOptionsControl SetUpdateControl (HPS.Window.UpdateControl in_control)
 Sets the type of update of this UpdateOptionsControl. More...
 
bool ShowTimeLimit (out double out_time_limit)
 Shows the time limit from this UpdateOptionsControl. More...
 
bool ShowUpdateControl (out HPS.Window.UpdateControl out_control)
 Shows the type of control from this UpdateOptionsControl. More...
 
HPS.UpdateOptionsControl UnsetEverything ()
 Removes all settings from this UpdateOptionsControl. More...
 
HPS.UpdateOptionsControl UnsetTimeLimit ()
 Removes the time limit of this UpdateOptionsControl. More...
 
HPS.UpdateOptionsControl UnsetUpdateControl ()
 Removes the type of control for this update Control. More...
 
 UpdateOptionsControl (HPS.WindowKey in_window)
 This constructor creates a UpdateOptionsControl object which is tied to the specified window. More...
 
 UpdateOptionsControl (HPS.UpdateOptionsControl in_that)
 The copy constructor creates a UpdateOptionsControl object that shares the underlying smart-pointer of the source UpdateOptionsControl. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
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 ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The UpdateOptionsControl class is a smart pointer that is tied to a database object.

It is used to set selection related options on a WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting. Default values for the various fields of UpdateOptionsControl can be found here.

Constructor & Destructor Documentation

HPS.UpdateOptionsControl.UpdateOptionsControl ( HPS.WindowKey  in_window)

This constructor creates a UpdateOptionsControl object which is tied to the specified window.

Parameters
in_windowThe window which this <ref refid="class_h_p_s_1_1_update_options_control" kindref="compound">UpdateOptionsControl</ref> should operate on.
HPS.UpdateOptionsControl.UpdateOptionsControl ( HPS.UpdateOptionsControl  in_that)

The copy constructor creates a UpdateOptionsControl object that shares the underlying smart-pointer of the source UpdateOptionsControl.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_update_options_control" kindref="compound">UpdateOptionsControl</ref> to copy.

Member Function Documentation

override HPS.Type HPS.UpdateOptionsControl.ObjectType ( )
virtual

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.

HPS.UpdateOptionsControl HPS.UpdateOptionsControl.SetTimeLimit ( double  in_time_limit)

Sets the time limit of this UpdateOptionsControl.

Parameters
in_time_limitThe time limit for this <ref refid="class_h_p_s_1_1_update_options_control" kindref="compound">UpdateOptionsControl</ref> update.
Returns
A reference to this UpdateOptionsControl.
HPS.UpdateOptionsControl HPS.UpdateOptionsControl.SetUpdateControl ( HPS.Window.UpdateControl  in_control)

Sets the type of update of this UpdateOptionsControl.

Parameters
in_controlThe type of update that this <ref refid="class_h_p_s_1_1_update_options_control" kindref="compound">UpdateOptionsControl</ref> will perform.
Returns
A reference to this UpdateOptionsControl.
bool HPS.UpdateOptionsControl.ShowTimeLimit ( out double  out_time_limit)

Shows the time limit from this UpdateOptionsControl.

Returns
true if the time limit is valid, false otherwise.
bool HPS.UpdateOptionsControl.ShowUpdateControl ( out HPS.Window.UpdateControl  out_control)

Shows the type of control from this UpdateOptionsControl.

Returns
true if the control is valid, false otherwise.
HPS.UpdateOptionsControl HPS.UpdateOptionsControl.UnsetEverything ( )

Removes all settings from this UpdateOptionsControl.

Returns
A reference to this UpdateOptionsControl.
HPS.UpdateOptionsControl HPS.UpdateOptionsControl.UnsetTimeLimit ( )

Removes the time limit of this UpdateOptionsControl.

Returns
A reference to this UpdateOptionsControl.
HPS.UpdateOptionsControl HPS.UpdateOptionsControl.UnsetUpdateControl ( )

Removes the type of control for this update Control.

Returns
A reference to this UpdateOptionsControl.

The documentation for this class was generated from the following file: