HighlightOptions class Leave feedback
On this page
Provides options for highlighting found terms.
Learn more
The HighlightOptions type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes a new instance of the HighlightOptions class. |
| Property | Description |
|---|---|
| highlight_color | The color used to highlight occurrences (default is #FFD800). |
| term_highlight_end_tag | The end tag of the highlighting of the found word. |
| term_highlight_start_tag | The start tag used to highlight a found word in plain‑text results. |
| terms_after | The maximum number of words in a text fragment after a highlighted word. |
| terms_before | The maximum number of words in a text fragment before highlighted word. |
| terms_total | The maximum number of words in a text fragment. The value must be in the range from 0 to 10000. The default value is 21. |
| use_inline_styles | The value indicating whether inline styles are used to highlight occurrences. The default value is True. |
| additional_fields | The additional document fields that was used for indexing. The default value is None. (inherited from TextOptions) |
| auto_detect_encoding | The auto_detect_encoding flag indicates whether to detect encoding automatically. The default value is False. (inherited from BaseOptions) |
| cancellation | The cancellation object. The default value is None. (inherited from TextOptions) |
| custom_extractor | The custom text extractor that was used for indexing. The default value is None. This value is used only if document text was not saved into the index. (inherited from TextOptions) |
| encoding | The encoding used to extract text from text documents. The default is None, which means UTF-8 is used. If AutoDetectEncoding is True, this value serves as the default encoding. (inherited from BaseOptions) |
| generate_head | The generate_head property indicates whether the Head tag is generated in the output HTML. (inherited from TextOptions) |
| image_indexing_options | The image indexing options for reverse image search. (inherited from BaseOptions) |
| metadata_indexing_options | The options for indexing metadata fields. (inherited from BaseOptions) |
| ocr_indexing_options | The options for OCR processing and indexing recognized text. (inherited from BaseOptions) |
| use_backup_privilege | The property indicates whether the process should use the SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS to access files and directories. The default value is False. True enables privileged access using SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS; otherwise, False. (inherited from BaseOptions) |
| use_raw_text_extraction | The property indicates whether raw text extraction mode is used if possible. The default is False; raw mode can significantly increase indexing speed, while normal mode improves formatting of extracted text. (inherited from BaseOptions) |
from groupdocs.search.options import Color, HighlightOptions
options = HighlightOptions()
options.terms_before = 5
options.terms_after = 5
options.terms_total = 15
options.highlight_color = Color(0, 0, 127)
options.use_inline_styles = True
Task guides that use HighlightOptions:
- module
groupdocs.search.options
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.
