Highlight
Leave feedback
On this page
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. |
| exception | condition |
|---|---|
| ArgumentException | The options have a custom extractor or a word splitter, which cannot be sent to the shard (see CustomExtractor and WordSplitter). |
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.
- class NetworkFoundDocument
- class Highlighter
- class HighlightOptions
- class Searcher
- namespace GroupDocs.Search.Scaling
- assembly GroupDocs.Search
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.