SearchHighlightOptionsTDocument Class |
Options for highlighting.
Inheritance HierarchyNamespace: MongoDB.Driver.Search
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
SyntaxType Parameters
- TDocument
- The type of the document.
The SearchHighlightOptionsTDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SearchHighlightOptionsTDocument(ExpressionFuncTDocument, Object, NullableInt32, NullableInt32) |
Creates highlighting options.
|
| SearchHighlightOptionsTDocument(SearchPathDefinitionTDocument, NullableInt32, NullableInt32) |
Initializes a new instance of the SearchHighlightOptionsTDocument class.
|
Properties| Name | Description | |
|---|---|---|
 | 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| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Render |
Renders the options to a BsonDocument.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | ToBson |
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.) |
| ToBsonDocument |
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.) |
| ToJson |
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.) |
See Also