| HighlightOptions Class |
Provides options for highlighting found terms.
Inheritance HierarchyNamespace: GroupDocs.Search.Options
Assembly: GroupDocs.Search (in GroupDocs.Search.dll) Version: 21.8.1
SyntaxThe HighlightOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HighlightOptions |
Initializes a new instance of the HighlightOptions class.
|
Properties| Name | Description | |
|---|---|---|
 | AdditionalFields |
Gets or sets the additional document fields that was used for indexing.
The default value is null.
Note that this value is used only if document text was not saved into the index.
(Inherited from TextOptions.) |
| Cancellation |
Gets or sets the cancellation object.
The default value is null.
(Inherited from TextOptions.) |
| CustomExtractor |
Gets or sets the custom text extractor that was used for indexing.
The default value is null.
Note that this value is used only if document text was not saved into the index.
(Inherited from TextOptions.) |
| GenerateHead |
Gets or sets a value indicating whether the Head tag is generated in the output HTML.
The default value is true.
(Inherited from TextOptions.) |
| HighlightColor |
Gets or sets a color that is used to highlight occurrences.
The default value is #FFD800.
|
| MetadataIndexingOptions |
Gets the options for indexing metadata fields.
(Inherited from TextOptions.) |
| OcrIndexingOptions |
Gets the options for OCR processing and indexing recognized text.
(Inherited from TextOptions.) |
| TermsAfter |
Gets or sets the maximum number of words in a text fragment after highlighted word.
The value must be in the range from 0 to 10000.
The default value is 7.
|
| TermsBefore |
Gets or sets the maximum number of words in a text fragment before highlighted word.
The value must be in the range from 0 to 10000.
The default value is 7.
|
| TermsTotal |
Gets or sets 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.
|
| UseInlineStyles |
Gets or sets a value indicating whether inline styles are used to highlight occurrences.
The default value is true.
|
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| ToString | (Inherited from Object.) |
RemarksLearn more
See Also