SortByBuilder Class

SortByBuilder Class

A builder for specifying a sort order.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.BuildersBuilderBase
MongoDB.Driver.BuildersSortByBuilder

Namespace: MongoDB.Driver.Builders
Assembly: MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.4.1

Syntax

[SerializableAttribute]
public class SortByBuilder : BuilderBase, 
	IMongoSortBy

<SerializableAttribute>
Public Class SortByBuilder
	Inherits BuilderBase
	Implements IMongoSortBy

[<SerializableAttribute>]
type SortByBuilder =  
    class
        inherit BuilderBase
        interface IMongoSortBy
    end

The SortByBuilder type exposes the following members.

Constructors

	Name	Description
	SortByBuilder	Initializes a new instance of the SortByBuider class.

Methods

	Name	Description
	Ascending	Adds keys to be sorted by in ascending order.
	Descending	Adds keys to be sorted by in descending order.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MetaTextScore	Adds a key to sort by the computed relevance score when using text search. The name of the key should be the name of the projected relevance score field.
	ToBsonDocument	Returns the result of the builder as a BsonDocument. (Overrides BuilderBaseToBsonDocument.)
	ToString	Returns a string representation of the settings. (Inherited from BuilderBase.)

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