HighlightOptions Class
Provides options for highlighting found terms.
Inheritance Hierarchy

Namespace: GroupDocs.Search.Options
Assembly: GroupDocs.Search (in GroupDocs.Search.dll) Version: 20.11
Syntax
public class HighlightOptions : TextOptions

The HighlightOptions type exposes the following members.

Constructors
  NameDescription
Public methodHighlightOptions
Initializes a new instance of the HighlightOptions class.
Properties
  NameDescription
Public propertyAdditionalFields
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.)
Public propertyCancellation
Gets or sets the cancellation object. The default value is null.
(Inherited from TextOptions.)
Public propertyCustomExtractor
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.)
Public propertyMetadataIndexingOptions
Gets the options for indexing metadata fields.
(Inherited from TextOptions.)
Public propertyTermsAfter
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.
Public propertyTermsBefore
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.
Public propertyTermsTotal
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.
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Remarks
See Also