Constructor SearchHighlightOptions

Namespace

MongoDB.Driver.Search

Assembly

MongoDB.Driver.dll

SearchHighlightOptions(SearchPathDefinition<TDocument>, int?, int?)

Initializes a new instance of the SearchHighlightOptions<TDocument> class.

public SearchHighlightOptions(SearchPathDefinition<TDocument> path, int? maxCharsToExamine = null, int? maxNumPassages = null)

Parameters

path SearchPathDefinition<TDocument>

The document field to search.

maxCharsToExamine int?

maximum number of characters to examine.

maxNumPassages int?

The number of high-scoring passages.

SearchHighlightOptions(Expression<Func<TDocument, object>>, int?, int?)

Creates highlighting options.

public SearchHighlightOptions(Expression<Func<TDocument, object>> path, int? maxCharsToExamine = null, int? maxNumPassages = null)

Parameters

path Expression<Func<TDocument, object>>

The document field to search.

maxCharsToExamine int?

The maximum number of characters to examine on a document when performing highlighting for a field.

maxNumPassages int?

The number of high-scoring passages to return per document in the highlighting results for each field.