Click or drag to resize

SearchHighlightOptionsTDocument Class

Options for highlighting.
Inheritance Hierarchy
SystemObject
  MongoDB.Driver.SearchSearchHighlightOptionsTDocument

Namespace:  MongoDB.Driver.Search
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
public sealed class SearchHighlightOptions<TDocument>

Type Parameters

TDocument
The type of the document.

The SearchHighlightOptionsTDocument type exposes the following members.

Constructors
  NameDescription
Public methodSearchHighlightOptionsTDocument(ExpressionFuncTDocument, Object, NullableInt32, NullableInt32)
Creates highlighting options.
Public methodSearchHighlightOptionsTDocument(SearchPathDefinitionTDocument, NullableInt32, NullableInt32)
Initializes a new instance of the SearchHighlightOptionsTDocument class.
Top
Properties
  NameDescription
Public propertyMaxCharsToExamine
Gets or sets the maximum number of characters to examine on a document when performing highlighting for a field.
Public propertyMaxNumPassages
Gets or sets the number of high-scoring passages to return per document in the highlighting results for each field.
Public propertyPath
Gets or sets the document field to search.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRender
Renders the options to a BsonDocument.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also