Collation Class

Represents a MongoDB collation.

Inheritance Hierarchy

SystemObject
MongoDB.DriverCollation

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242

Syntax

public sealed class Collation : IEquatable<Collation>, 
	IConvertibleToBsonDocument

Public NotInheritable Class Collation
	Implements IEquatable(Of Collation), IConvertibleToBsonDocument

[<SealedAttribute>]
type Collation =  
    class
        interface IEquatable<Collation>
        interface IConvertibleToBsonDocument
    end

The Collation type exposes the following members.

Constructors

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

Properties

	Name	Description
	Alternate	Gets whether spaces and punctuation are considered base characters.
	Backwards	Gets whether secondary differencs are to be considered in reverse order.
	CaseFirst	Gets whether upper case or lower case is ordered first.
	CaseLevel	Gets whether the collation is case sensitive at strength 1 and 2.
	Locale	Gets the locale.
	MaxVariable	Gets which characters are affected by the alternate: "Shifted".
	Normalization	Gets the normalization.
	NumericOrdering	Gets whether numbers are ordered numerically.
	Simple	Gets the simple binary compare collation.
	Strength	Gets the strength.

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object).)
	Equals(Collation)	Indicates whether the current object is equal to another object of the same type.
	FromBsonDocument	Creates a Collation instance from a BsonDocument.
	GetHashCode	Serves as the default hash function. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToBsonDocument	Converts this object to a BsonDocument.
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	With	Creates a new Collation instance with some properties changed.

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