
Public Member Functions | |
override void | Dispose () |
HPS.KeyPath | GetItem () |
Returns the item that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid. This method is functionally equivalent to the overloaded operator*. More... | |
HPS.Drawing.Overlay | GetOverlay () |
Returns the overlay type for the key path that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid. More... | |
bool | GetPassive () |
Indicates whether the highlight associated with this iterator is passive. Throws an InvalidObjectException if the iterator is not valid. More... | |
string | GetStyleName () |
Returns the highlight style for the key path that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid. More... | |
HighlightSearchResultsIterator () | |
The default constructor creates a new HighlightSearchResultsIterator object that is not associated with any HighlightSearchResults object. More... | |
HighlightSearchResultsIterator (HPS.HighlightSearchResultsIterator in_search_results_iterator) | |
The copy constructor initializes a new HighlightSearchResultsIterator object that is associated with the same HighlightSearchResults object as the source and at the same location in the results. Subsequent changes to either iterator will not affect the other. More... | |
bool | IsValid () |
Queries the validity of this iterator location. Invalid locations would include uninitialized iterators and iterators that had walked past the last element. More... | |
void | Next () |
Advances the iterator to the next search result item More... | |
override HPS.Type | ObjectType () |
override void | Reset () |
Resets iterator to the beginning of the associated search results. More... | |
void | Set (HPS.HighlightSearchResultsIterator in_search_results_iterator) |
Copies a HighlightSearchResultsIterator object, associating this object with the same HighlightSearchResults object as the source and at the same location in the results. Subsequent changes to either iterator will not affect the other. This method is functionally equivalent to the overloaded assignment operator except for the return value. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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 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 |
Detailed Description
An iterator used for traversing results from a search on an associated HighlightSearchResults object.
Constructor & Destructor Documentation
|
inline |
The default constructor creates a new HighlightSearchResultsIterator object that is not associated with any HighlightSearchResults object.
|
inline |
The copy constructor initializes a new HighlightSearchResultsIterator object that is associated with the same HighlightSearchResults object as the source and at the same location in the results. Subsequent changes to either iterator will not affect the other.
- Parameters
-
in_search_results_iterator The source of the copy.
Member Function Documentation
|
inline |
Returns the item that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid. This method is functionally equivalent to the overloaded operator*.
- Returns
- The current item.
|
inline |
Returns the overlay type for the key path that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid.
- Returns
- The overlay type.
|
inline |
Indicates whether the highlight associated with this iterator is passive. Throws an InvalidObjectException if the iterator is not valid.
- Returns
- Whether the highlight is passive.
|
inline |
Returns the highlight style for the key path that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid.
- Returns
- The highlight style.
|
inline |
Queries the validity of this iterator location. Invalid locations would include uninitialized iterators and iterators that had walked past the last element.
- Returns
- true if this iterator is pointing to a valid item, false otherwise.
|
inline |
Advances the iterator to the next search result item
|
inlinevirtual |
Resets iterator to the beginning of the associated search results.
Reimplemented from HPS.Object.
|
inline |
Copies a HighlightSearchResultsIterator object, associating this object with the same HighlightSearchResults object as the source and at the same location in the results. Subsequent changes to either iterator will not affect the other. This method is functionally equivalent to the overloaded assignment operator except for the return value.
- Parameters
-
in_search_results_iterator The source of the copy.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.HighlightSearchResultsIterator.cs