REFERENCE MANUAL
The HighlightControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
override void | Dispose () |
HPS.HighlightControl | Highlight (HPS.SelectionResults in_items, HPS.HighlightOptionsKit in_options) |
Highlight the specified selection results using the specified highlight options. More... | |
HPS.HighlightControl | Highlight (HPS.SelectionItem in_item, HPS.HighlightOptionsKit in_options) |
Highlight the specified selection item using the specified highlight options. More... | |
HPS.HighlightControl | Highlight (HPS.SearchResults in_items, HPS.HighlightOptionsKit in_options) |
Highlight the specified selection results using the specified highlight options. More... | |
HPS.HighlightControl | Highlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options) |
Highlight the specified selection item using the specified highlight options. More... | |
HPS.HighlightControl | Highlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options) |
Highlight the specified selection item using the specified highlight options. More... | |
HighlightControl (HPS.WindowKey in_window) | |
This constructor creates a HighlightControl object which is tied to the specified window. More... | |
HighlightControl (HPS.HighlightControl in_that) | |
The copy constructor creates a HighlightControl object that shares the underlying smart-pointer of the source HighlightControl. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.HighlightControl | Unhighlight (HPS.SelectionResults in_items, HPS.HighlightOptionsKit in_options) |
Unhighlight the specified selection results by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.SelectionResults in_items) |
Unhighlight the specified selection results by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.SelectionItem in_item, HPS.HighlightOptionsKit in_options) |
Unhighlight the specified selection item by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.SelectionItem in_item) |
Unhighlight the specified selection item by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.SearchResults in_items, HPS.HighlightOptionsKit in_options) |
Unhighlight the specified selection results by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.SearchResults in_items) |
Unhighlight the specified selection results by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options) |
Unhighlight the specified selection item by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.KeyPath in_item) |
Unhighlight the specified selection item by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options) |
Unhighlight the specified selection item by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.Key in_item) |
Unhighlight the specified selection item by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.HighlightOptionsKit in_options) |
Unhighlight geometry which was highlighted with the specified HighlightOptionsKit. More... | |
HPS.HighlightControl | UnhighlightEverything () |
Unhighlight everything in the window associated with this HighlightControl. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
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 () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The HighlightControl class is a smart pointer that is tied to a database object.
It is used to control highlight and unhighlight operations on selection results, search results, key paths and keys. This table lists default * values for the various segment attributes accessible from HighlightControl.
HPS.HighlightControl.HighlightControl | ( | HPS.WindowKey | in_window | ) |
This constructor creates a HighlightControl object which is tied to the specified window.
in_window | The window which this <ref refid="class_h_p_s_1_1_highlight_control" kindref="compound">HighlightControl</ref> should operate on. |
HPS.HighlightControl.HighlightControl | ( | HPS.HighlightControl | in_that | ) |
The copy constructor creates a HighlightControl object that shares the underlying smart-pointer of the source HighlightControl.
in_that | The source <ref refid="class_h_p_s_1_1_highlight_control" kindref="compound">HighlightControl</ref> to copy. |
HPS.HighlightControl HPS.HighlightControl.Highlight | ( | HPS.SelectionResults | in_items, |
HPS.HighlightOptionsKit | in_options | ||
) |
Highlight the specified selection results using the specified highlight options.
in_items | The selection results to highlight. If there are invalid selection items in the selection results, an exception will be thrown. |
in_options | The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown. |
HPS.HighlightControl HPS.HighlightControl.Highlight | ( | HPS.SelectionItem | in_item, |
HPS.HighlightOptionsKit | in_options | ||
) |
Highlight the specified selection item using the specified highlight options.
in_item | The selection item to highlight. If the selection item is invalid, an exception will be thrown. |
in_options | The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown. |
HPS.HighlightControl HPS.HighlightControl.Highlight | ( | HPS.SearchResults | in_items, |
HPS.HighlightOptionsKit | in_options | ||
) |
Highlight the specified selection results using the specified highlight options.
in_items | The selection results to highlight. If there are invalid selection items in the selection results, an exception will be thrown. |
in_options | The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown. |
HPS.HighlightControl HPS.HighlightControl.Highlight | ( | HPS.KeyPath | in_item, |
HPS.HighlightOptionsKit | in_options | ||
) |
Highlight the specified selection item using the specified highlight options.
in_item | The selection item to highlight. If the selection item is invalid, an exception will be thrown. |
in_options | The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown. |
HPS.HighlightControl HPS.HighlightControl.Highlight | ( | HPS.Key | in_item, |
HPS.HighlightOptionsKit | in_options | ||
) |
Highlight the specified selection item using the specified highlight options.
in_item | The selection item to highlight. If the selection item is invalid, an exception will be thrown. |
in_options | The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown. |
|
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.HighlightControl HPS.HighlightControl.Unhighlight | ( | HPS.SelectionResults | in_items, |
HPS.HighlightOptionsKit | in_options | ||
) |
Unhighlight the specified selection results by removing the specified highlight options.
in_items | The selection results to unhighlight. If there are invalid selection items in the selection results, an exception will be thrown. |
in_options | The highlight options to be removed. Defaults to an empty <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>. |
HPS.HighlightControl HPS.HighlightControl.Unhighlight | ( | HPS.SelectionResults | in_items | ) |
Unhighlight the specified selection results by removing the specified highlight options.
in_items | The selection results to unhighlight. If there are invalid selection items in the selection results, an exception will be thrown. |
HPS.HighlightControl HPS.HighlightControl.Unhighlight | ( | HPS.SelectionItem | in_item, |
HPS.HighlightOptionsKit | in_options | ||
) |
Unhighlight the specified selection item by removing the specified highlight options.
in_item | The selection item to unhighlight. If the selection item is invalid, an exception will be thrown. |
in_options | The highlight options to be removed. Defaults to an empty <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>. |
HPS.HighlightControl HPS.HighlightControl.Unhighlight | ( | HPS.SelectionItem | in_item | ) |
Unhighlight the specified selection item by removing the specified highlight options.
in_item | The selection item to unhighlight. If the selection item is invalid, an exception will be thrown. |
HPS.HighlightControl HPS.HighlightControl.Unhighlight | ( | HPS.SearchResults | in_items, |
HPS.HighlightOptionsKit | in_options | ||
) |
Unhighlight the specified selection results by removing the specified highlight options.
in_items | The selection results to unhighlight. If there are invalid selection items in the selection results, an exception will be thrown. |
in_options | The highlight options to be removed. Defaults to an empty <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>. |
HPS.HighlightControl HPS.HighlightControl.Unhighlight | ( | HPS.SearchResults | in_items | ) |
Unhighlight the specified selection results by removing the specified highlight options.
in_items | The selection results to unhighlight. If there are invalid selection items in the selection results, an exception will be thrown. |
HPS.HighlightControl HPS.HighlightControl.Unhighlight | ( | HPS.KeyPath | in_item, |
HPS.HighlightOptionsKit | in_options | ||
) |
Unhighlight the specified selection item by removing the specified highlight options.
in_item | The selection item to unhighlight. If the selection item is invalid, an exception will be thrown. |
in_options | The highlight options to be removed. Defaults to an empty <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>. |
HPS.HighlightControl HPS.HighlightControl.Unhighlight | ( | HPS.KeyPath | in_item | ) |
Unhighlight the specified selection item by removing the specified highlight options.
in_item | The selection item to unhighlight. If the selection item is invalid, an exception will be thrown. |
HPS.HighlightControl HPS.HighlightControl.Unhighlight | ( | HPS.Key | in_item, |
HPS.HighlightOptionsKit | in_options | ||
) |
Unhighlight the specified selection item by removing the specified highlight options.
in_item | The selection item to unhighlight. If the selection item is invalid, an exception will be thrown. |
in_options | The highlight options to be removed. Defaults to an empty <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>. |
HPS.HighlightControl HPS.HighlightControl.Unhighlight | ( | HPS.Key | in_item | ) |
Unhighlight the specified selection item by removing the specified highlight options.
in_item | The selection item to unhighlight. If the selection item is invalid, an exception will be thrown. |
HPS.HighlightControl HPS.HighlightControl.Unhighlight | ( | HPS.HighlightOptionsKit | in_options | ) |
Unhighlight geometry which was highlighted with the specified HighlightOptionsKit.
in_options | The highlight options to be removed. |
HPS.HighlightControl HPS.HighlightControl.UnhighlightEverything | ( | ) |
Unhighlight everything in the window associated with this HighlightControl.