The HPS::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 HPS::HighlightControl. 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 search results using the specified highlight options. More... | |
HPS.HighlightControl | Highlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options) |
Highlight the specified key path using the specified highlight options. More... | |
HPS.HighlightControl | Highlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options) |
Highlight the specified key 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. This does not necessarily give the true type of the underlying object. 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 search results by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.SearchResults in_items) |
Unhighlight the specified search results by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options) |
Unhighlight the specified key path by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.KeyPath in_item) |
Unhighlight the specified key path by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options) |
Unhighlight the specified key by removing the specified highlight options. More... | |
HPS.HighlightControl | Unhighlight (HPS.Key in_item) |
Unhighlight the specified key 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. 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... | |
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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
Detailed Description
The HPS::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 HPS::HighlightControl.
Constructor & Destructor Documentation
|
inline |
This constructor creates a HighlightControl object which is tied to the specified window.
- Parameters
-
in_window The window which this HighlightControl should operate on.
|
inline |
The copy constructor creates a HighlightControl object that shares the underlying smart-pointer of the source HighlightControl.
- Parameters
-
in_that The source HighlightControl to copy.
Member Function Documentation
|
inline |
Highlight the specified selection results using the specified highlight options.
- Parameters
-
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.
- Returns
- A reference to this HighlightControl.
|
inline |
Highlight the specified selection item using the specified highlight options.
- Parameters
-
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.
- Returns
- A reference to this HighlightControl.
|
inline |
Highlight the specified search results using the specified highlight options.
- Parameters
-
in_items The search results to highlight. If there are invalid keys 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.
- Returns
- A reference to this HighlightControl.
|
inline |
Highlight the specified key path using the specified highlight options.
- Parameters
-
in_item The key path to highlight. If there are no keys or invalid keys in the key path, 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.
- Returns
- A reference to this HighlightControl.
|
inline |
Highlight the specified key using the specified highlight options.
- Parameters
-
in_item The key to highlight. If the key 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.
- Returns
- A reference to this HighlightControl.
|
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.
|
inline |
Unhighlight the specified selection results by removing the specified highlight options.
- Parameters
-
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 HighlightOptionsKit.
- Returns
- A reference to this HighlightControl.
|
inline |
Unhighlight the specified selection results by removing the specified highlight options.
- Parameters
-
in_items The selection results to unhighlight. If there are invalid selection items in the selection results, an exception will be thrown.
- Returns
- A reference to this HighlightControl.
|
inline |
Unhighlight the specified selection item by removing the specified highlight options.
- Parameters
-
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 HighlightOptionsKit.
- Returns
- A reference to this HighlightControl.
|
inline |
Unhighlight the specified selection item by removing the specified highlight options.
- Parameters
-
in_item The selection item to unhighlight. If the selection item is invalid, an exception will be thrown.
- Returns
- A reference to this HighlightControl.
|
inline |
Unhighlight the specified search results by removing the specified highlight options.
- Parameters
-
in_items The search results to unhighlight. If there are invalid keys in the search results, an exception will be thrown. in_options The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
- Returns
- A reference to this HighlightControl.
|
inline |
Unhighlight the specified search results by removing the specified highlight options.
- Parameters
-
in_items The search results to unhighlight. If there are invalid keys in the search results, an exception will be thrown.
- Returns
- A reference to this HighlightControl.
|
inline |
Unhighlight the specified key path by removing the specified highlight options.
- Parameters
-
in_item The key path to unhighlight. If there are no keys or invalid keys in the key path, an exception will be thrown. in_options The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
- Returns
- A reference to this HighlightControl.
|
inline |
Unhighlight the specified key path by removing the specified highlight options.
- Parameters
-
in_item The key path to unhighlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
- Returns
- A reference to this HighlightControl.
|
inline |
Unhighlight the specified key by removing the specified highlight options.
- Parameters
-
in_item The key to unhighlight. If the key is invalid, an exception will be thrown.. in_options The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
- Returns
- A reference to this HighlightControl.
|
inline |
Unhighlight the specified key by removing the specified highlight options.
- Parameters
-
in_item The key to unhighlight. If the key is invalid, an exception will be thrown..
- Returns
- A reference to this HighlightControl.
|
inline |
Unhighlight geometry which was highlighted with the specified HighlightOptionsKit.
- Parameters
-
in_options The highlight options to be removed.
- Returns
- A reference to this HighlightControl.
|
inline |
Unhighlight everything in the window associated with this HighlightControl.
- Returns
- A reference to this HighlightControl.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.HighlightControl.cs