Click or drag to resize

SearchHighlightOptions<TDocument> Constructor (Expression<Func<TDocument, Object>>, Nullable<Int32>, Nullable<Int32>)

Creates highlighting options.

Namespace:  MongoDB.Driver.Search
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax
public SearchHighlightOptions(
	Expression<Func<TDocument, Object>> path,
	Nullable<int> maxCharsToExamine = null,
	Nullable<int> maxNumPassages = null
)

Parameters

path
Type: System.Linq.Expressions.Expression<Func<TDocument, Object>>
The document field to search.
maxCharsToExamine (Optional)
Type: System.Nullable<Int32>
The maximum number of characters to examine on a document when performing highlighting for a field.
maxNumPassages (Optional)
Type: System.Nullable<Int32>
The number of high-scoring passages to return per document in the highlighting results for each field.

Return Value

Type: 
Highlighting options.
See Also