HPS.HighlightSearchResultsIterator Class Reference
Inheritance diagram for HPS.HighlightSearchResultsIterator:
HPS.Object

Public Member Functions

override void Dispose ()
 
HPS.KeyPath GetItem ()
 
HPS.Drawing.Overlay GetOverlay ()
 
bool GetPassive ()
 
string GetStyleName ()
 
 HighlightSearchResultsIterator ()
 
 HighlightSearchResultsIterator (HPS.HighlightSearchResultsIterator in_search_results_iterator)
 
bool IsValid ()
 
void Next ()
 
override HPS.Type ObjectType ()
 
override void Reset ()
 
void Set (HPS.HighlightSearchResultsIterator in_search_results_iterator)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual HPS.Type Type ()
 

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
 

Detailed Description

An iterator used for traversing results from a search on an associated HighlightSearchResults object.

Constructor & Destructor Documentation

◆ HighlightSearchResultsIterator() [1/2]

HPS.HighlightSearchResultsIterator.HighlightSearchResultsIterator ( )
inline

The default constructor creates a new HighlightSearchResultsIterator object that is not associated with any HighlightSearchResults object.

◆ HighlightSearchResultsIterator() [2/2]

HPS.HighlightSearchResultsIterator.HighlightSearchResultsIterator ( HPS.HighlightSearchResultsIterator  in_search_results_iterator)
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_iteratorThe source of the copy.

Member Function Documentation

◆ 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()

HPS.Drawing.Overlay HPS.HighlightSearchResultsIterator.GetOverlay ( )
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.

◆ 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()

void HPS.HighlightSearchResultsIterator.Set ( HPS.HighlightSearchResultsIterator  in_search_results_iterator)
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_iteratorThe source of the copy.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.HighlightSearchResultsIterator.cs