HighlightOptions class

HighlightOptions class

Provides the options which are used to extract a highlight (a block of text aroud found text in search scenarios).

The HighlightOptions type exposes the following members:

Constructors

Constructor Description
init Initializes a new instance of the HighlightOptions class which is used to extract a fixed-length highlight.
init Initializes a new instance of the HighlightOptions class which is used to extract a fixed-length highlight.
init Constructs a new instance of HighlightOptions
init Constructs a new instance of HighlightOptions
init Constructs a new instance of HighlightOptions

Properties

Property Description
max_length Gets a maximum text length.
word_count Gets a maximum word count.
is_line_limited Gets value that indicates whether highlight extraction is limited by the start (or the end) of a text line.

Remarks

An instance of HighlightOptions class is used as parameter in Parser.get_highlight method. See the usage examples there.

See Also