Class SearchHighlight

Represents a result of highlighting.

public sealed class SearchHighlight

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Initializes a new instance of the SearchHighlight class.

public SearchHighlight(string path, double score, SearchHighlightText[] texts)

path string: document field which returned a match.
score double: Score assigned to this result.
texts SearchHighlightText[]: Objects containing the matching text and the surrounding text.

Gets the document field which returned a match.

[BsonElement("path")]
public string Path { get; }

Gets the score assigned to this result.

[BsonElement("score")]
public double Score { get; }

Gets one or more objects containing the matching text and the surrounding text (if any).

[BsonDefaultValue(null)]
[BsonElement("texts")]
public SearchHighlightText[] Texts { get; }