SearchHighlightOptionsTDocument Constructor (ExpressionFuncTDocument, Object, NullableInt32, NullableInt32) |
Creates highlighting options.
Namespace:
MongoDB.Driver.Search
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax public SearchHighlightOptions(
Expression<Func<TDocument, Object>> path,
int? maxCharsToExamine = null,
int? maxNumPassages = null
)
Public Sub New (
path As Expression(Of Func(Of TDocument, Object)),
Optional maxCharsToExamine As Integer? = Nothing,
Optional maxNumPassages As Integer? = Nothing
)
new :
path : Expression<Func<'TDocument, Object>> *
?maxCharsToExamine : Nullable<int> *
?maxNumPassages : Nullable<int>
(* Defaults:
let _maxCharsToExamine = defaultArg maxCharsToExamine null
let _maxNumPassages = defaultArg maxNumPassages null
*)
-> SearchHighlightOptions
Parameters
- path
- Type: System.Linq.ExpressionsExpressionFuncTDocument, Object
The document field to search. - maxCharsToExamine (Optional)
- Type: SystemNullableInt32
The maximum number of characters to examine on a document when performing highlighting
for a field.
- maxNumPassages (Optional)
- Type: SystemNullableInt32
The number of high-scoring passages to return per document in the highlighting results
for each field.
Return Value
Type:
Highlighting options.
See Also