Highlight

Searcher.Highlight method

Highlights the found terms in the text of the found document using the specified highlighter.

public void Highlight(NetworkFoundDocument document, Highlighter highlighter, 
    HighlightOptions options)
Parameter Type Description
document NetworkFoundDocument The found document.
highlighter Highlighter The search result highlighter.
options HighlightOptions The highlight options.

Exceptions

exception condition
ArgumentException The options have a custom extractor or a word splitter, which cannot be sent to the shard (see CustomExtractor and WordSplitter).

Remarks

A cancellation that Cancellation requests ends the call at once, and the highlighter gets no text. A shard that has got the request completes the highlighting, and its result is ignored.

See Also