|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
An iterator used for traversing results from a search on an associated HighlightSearchResults object.
◆ HighlightSearchResultsIterator() [1/2]
HPS.HighlightSearchResultsIterator.HighlightSearchResultsIterator |
( |
| ) |
|
|
inline |
◆ HighlightSearchResultsIterator() [2/2]
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. |
◆ GetItem()
HPS.KeyPath HPS.HighlightSearchResultsIterator.GetItem |
( |
| ) |
|
|
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.
◆ 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.
- Returns
- The overlay type.
◆ GetPassive()
bool HPS.HighlightSearchResultsIterator.GetPassive |
( |
| ) |
|
|
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.
◆ GetStyleName()
string HPS.HighlightSearchResultsIterator.GetStyleName |
( |
| ) |
|
|
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.
◆ IsValid()
bool HPS.HighlightSearchResultsIterator.IsValid |
( |
| ) |
|
|
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.
◆ Next()
void HPS.HighlightSearchResultsIterator.Next |
( |
| ) |
|
|
inline |
Advances the iterator to the next search result item
◆ ObjectType()
override HPS.Type HPS.HighlightSearchResultsIterator.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.Object.
◆ Reset()
override void HPS.HighlightSearchResultsIterator.Reset |
( |
| ) |
|
|
inlinevirtual |
Resets iterator to the beginning of the associated search results.
Reimplemented from HPS.Object.
◆ Set()
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