SearchHighlight Class

Represents a result of highlighting.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.SearchSearchHighlight

Namespace: MongoDB.Driver.Search
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

public sealed class SearchHighlight

Public NotInheritable Class SearchHighlight

[<SealedAttribute>]
type SearchHighlight =  class end

The SearchHighlight type exposes the following members.

Constructors

	Name	Description
	SearchHighlight	Initializes a new instance of the SearchHighlight class.

Properties

	Name	Description
	Path	Gets the document field which returned a match.
	Score	Gets the score assigned to this result.
	Texts	Gets one or more objects containing the matching text and the surrounding text (if any).

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.)
	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.)