1. GroupDocs.Search
  2. /
  3. GroupDocs.Search for .NET
  4. /
  5. GroupDocs.Search.Options
  6. /
  7. HighlightOptions

HighlightOptions

On this page

HighlightOptions class

Provides options for highlighting found terms.

public class HighlightOptions : TextOptions

Constructors

Name Description
HighlightOptions() Initializes a new instance of the HighlightOptions class.

Properties

Name Description
AdditionalFields { get; set; } 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.
AutoDetectEncoding { get; set; } Gets or sets a value indicating whether to detect encoding automatically or not. The default value is false.
Cancellation { get; set; } Gets or sets the cancellation object. The default value is null.
CustomExtractor { get; set; } 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.
Encoding { get; set; } Gets or sets the encoding used to extract text from text documents. The default value is null, which means that the default encoding UTF-8 is used. If AutoDetectEncoding is true then this value is used as the default encoding.
GenerateHead { get; set; } Gets or sets a value indicating whether the Head tag is generated in the output HTML. The default value is true.
HighlightColor { get; set; } Gets or sets a color that is used to highlight occurrences. The default value is #FFD800.
ImageIndexingOptions { get; } Gets the image indexing options for reverse image search.
MetadataIndexingOptions { get; } Gets the options for indexing metadata fields.
OcrIndexingOptions { get; } Gets the options for OCR processing and indexing recognized text.
TermHighlightEndTag { get; set; } Gets of sets the end tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.
TermHighlightStartTag { get; set; } Gets of sets the start tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.
TermsAfter { get; set; } 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 { get; set; } 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 { get; set; } 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.
UseBackupPrivilege { get; set; } Gets or sets a value indicating whether the process should use the SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS to access files and directories. The default value is false.
UseInlineStyles { get; set; } Gets or sets a value indicating whether inline styles are used to highlight occurrences. The default value is true.
UseRawTextExtraction { get; set; } Gets or sets a value indicating whether the raw mode is used for text extraction if possible. The default value is false. The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.

Remarks

Learn more

See Also

On this page