Class SearchHighlightOptions<TDocument>

Namespace: MongoDB.Driver.Search

Assembly: MongoDB.Driver.dll

Options for highlighting.

public sealed class SearchHighlightOptions<TDocument>

Type Parameters

TDocument: The type of the document.

Inheritance: object

SearchHighlightOptions<TDocument>

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SearchHighlightOptions(SearchPathDefinition<TDocument>, int?, int?): Initializes a new instance of the SearchHighlightOptions<TDocument> class.

SearchHighlightOptions(Expression<Func<TDocument, object>>, int?, int?): Creates highlighting options.

Properties

MaxCharsToExamine: Gets or sets the maximum number of characters to examine on a document when performing highlighting for a field.

MaxNumPassages: Gets or sets the number of high-scoring passages to return per document in the highlighting results for each field.

Path: Gets or sets the document field to search.

Methods

Render(SearchDefinitionRenderContext<TDocument>): Renders the options to a BsonDocument.