HighlightItem class

HighlightItem class

Represents a highlight, a part of the text which is usually used to explain the context of the found text in the search functionality.

The HighlightItem type exposes the following members:

Properties

Property Description
position Gets the position in the document text.
text Gets the text of the highlight.

Remarks

An instance of HighlightItem class is used as return value of Parser.get_highlight method, SearchResult.left_highlight_item and SearchResult.right_highlight_item properties. See the usage examples there.

See Also