HighlightOptions Class - GroupDocs.Parser for .NET

HighlightOptions Class

Provides the options which are used to extract a highlight (a block of text aroud found text in search scenarios).

Inheritance Hierarchy

SystemObject
GroupDocs.Parser.OptionsHighlightOptions

Namespace: GroupDocs.Parser.Options
Assembly: GroupDocs.Parser (in GroupDocs.Parser.dll) Version: 21.5.0

Syntax

public sealed class HighlightOptions

Public NotInheritable Class HighlightOptions

public ref class HighlightOptions sealed

[<SealedAttribute>]
type HighlightOptions =  class end

The HighlightOptions type exposes the following members.

Constructors

	Name	Description
	HighlightOptions(Int32)	Initializes a new instance of the HighlightOptions class which is used to extract a fixed-length highlight.
	HighlightOptions(NullableInt32, Boolean)	Initializes a new instance of the HighlightOptions class which is used to extract a line-limited highlight.
	HighlightOptions(NullableInt32, Int32)	Initializes a new instance of the HighlightOptions class which is used to extract a highlight with the fixed word count.
	HighlightOptions(NullableInt32, NullableInt32, Boolean)	Initializes a new instance of the HighlightOptions class.

Properties

	Name	Description
	IsLineLimited	Gets value that indicates whether highlight extraction is limited by the start (or the end) of a text line.
	MaxLength	Gets a maximum text length.
	WordCount	Gets a maximum word count.

Methods

Remarks

An instance of HighlightOptions class is used as parameter in GetHighlight(Int32, Boolean, HighlightOptions) method. See the usage examples there.

Remarks

Learn more: