Click or drag to resize

IndexKeysDocument Class

Represents a BSON document that can be used where an IMongoIndexKeys is expected.
Inheritance Hierarchy

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax
public class IndexKeysDocument : BsonDocument, 
	IMongoIndexKeys

The IndexKeysDocument type exposes the following members.

Constructors
  NameDescription
Public methodIndexKeysDocument
Initializes a new instance of the IndexKeysDocument class.
Public methodIndexKeysDocument(Boolean)
Initializes a new instance of the IndexKeysDocument class specifying whether duplicate element names are allowed (allowing duplicate element names is not recommended).
Public methodIndexKeysDocument(BsonElement)
Initializes a new instance of the IndexKeysDocument class and adds one element.
Public methodIndexKeysDocument(BsonElement) Obsolete.
Initializes a new instance of the IndexKeysDocument class and adds one or more elements.
Public methodIndexKeysDocument(DictionaryString, Object)
Initializes a new instance of the IndexKeysDocument class and adds new elements from a dictionary of key/value pairs.
Public methodIndexKeysDocument(IDictionary)
Initializes a new instance of the IndexKeysDocument class and adds new elements from a dictionary of key/value pairs.
Public methodIndexKeysDocument(IEnumerableBsonElement)
Initializes a new instance of the IndexKeysDocument class and adds new elements from a list of elements.
Public methodIndexKeysDocument(IEnumerableKeyValuePairString, Object)
Initializes a new instance of the IndexKeysDocument class and adds new elements from a dictionary of key/value pairs.
Public methodIndexKeysDocument(DictionaryString, Object, IEnumerableString) Obsolete.
Initializes a new instance of the IndexKeysDocument class and adds new elements from a dictionary of key/value pairs.
Public methodIndexKeysDocument(IDictionary, IEnumerable) Obsolete.
Initializes a new instance of the IndexKeysDocument class and adds new elements from a dictionary of key/value pairs.
Public methodIndexKeysDocument(IDictionaryString, Object, IEnumerableString) Obsolete.
Initializes a new instance of the IndexKeysDocument class and adds new elements from a dictionary of key/value pairs.
Public methodIndexKeysDocument(String, BsonValue)
Initializes a new instance of the IndexKeysDocument class and creates and adds a new element.
Top
Properties
  NameDescription
Public propertyAllowDuplicateNames
Gets or sets whether to allow duplicate names (allowing duplicate names is not recommended).
(Inherited from BsonDocument.)
Public propertyAsBoolean
Casts the BsonValue to a Boolean (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonArray
Casts the BsonValue to a BsonArray (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonBinaryData
Casts the BsonValue to a BsonBinaryData (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonDateTime
Casts the BsonValue to a BsonDateTime (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonDocument
Casts the BsonValue to a BsonDocument (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonJavaScript
Casts the BsonValue to a BsonJavaScript (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonJavaScriptWithScope
Casts the BsonValue to a BsonJavaScriptWithScope (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonMaxKey
Casts the BsonValue to a BsonMaxKey (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonMinKey
Casts the BsonValue to a BsonMinKey (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonNull
Casts the BsonValue to a BsonNull (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonRegularExpression
Casts the BsonValue to a BsonRegularExpression (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonSymbol
Casts the BsonValue to a BsonSymbol (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonTimestamp
Casts the BsonValue to a BsonTimestamp (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonUndefined
Casts the BsonValue to a BsonUndefined (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsBsonValue
Casts the BsonValue to a BsonValue (a way of upcasting subclasses of BsonValue to BsonValue at compile time).
(Inherited from BsonValue.)
Public propertyAsByteArray
Casts the BsonValue to a Byte[] (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsDateTime Obsolete.
Casts the BsonValue to a DateTime in UTC (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsDecimal
Casts the BsonValue to a Decimal (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsDecimal128
Casts the BsonValue to a Decimal128 (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsDouble
Casts the BsonValue to a Double (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsGuid
Casts the BsonValue to a Guid (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsInt32
Casts the BsonValue to an Int32 (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsInt64
Casts the BsonValue to a Int64 (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsLocalTime Obsolete.
Casts the BsonValue to a DateTime in the local timezone (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsNullableBoolean
Casts the BsonValue to a Nullable{Boolean} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsNullableDateTime Obsolete.
Casts the BsonValue to a Nullable{DateTime} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsNullableDecimal
Casts the BsonValue to a Nullable{Decimal} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsNullableDecimal128
Casts the BsonValue to a Nullable{Decimal128} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsNullableDouble
Casts the BsonValue to a Nullable{Double} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsNullableGuid
Casts the BsonValue to a Nullable{Guid} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsNullableInt32
Casts the BsonValue to a Nullable{Int32} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsNullableInt64
Casts the BsonValue to a Nullable{Int64} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsNullableObjectId
Casts the BsonValue to a Nullable{ObjectId} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsObjectId
Casts the BsonValue to an ObjectId (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsRegex
Casts the BsonValue to a Regex (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsString
Casts the BsonValue to a String (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyAsUniversalTime Obsolete.
Casts the BsonValue to a DateTime in UTC (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.)
Public propertyBsonType
Gets the BsonType of this BsonValue.
(Inherited from BsonDocument.)
Public propertyElementCount
Gets the number of elements.
(Inherited from BsonDocument.)
Public propertyElements
Gets the elements.
(Inherited from BsonDocument.)
Public propertyIsBoolean
Tests whether this BsonValue is a Boolean.
(Inherited from BsonValue.)
Public propertyIsBsonArray
Tests whether this BsonValue is a BsonArray.
(Inherited from BsonValue.)
Public propertyIsBsonBinaryData
Tests whether this BsonValue is a BsonBinaryData.
(Inherited from BsonValue.)
Public propertyIsBsonDateTime
Tests whether this BsonValue is a BsonDateTime.
(Inherited from BsonValue.)
Public propertyIsBsonDocument
Tests whether this BsonValue is a BsonDocument.
(Inherited from BsonValue.)
Public propertyIsBsonJavaScript
Tests whether this BsonValue is a BsonJavaScript.
(Inherited from BsonValue.)
Public propertyIsBsonJavaScriptWithScope
Tests whether this BsonValue is a BsonJavaScriptWithScope.
(Inherited from BsonValue.)
Public propertyIsBsonMaxKey
Tests whether this BsonValue is a BsonMaxKey.
(Inherited from BsonValue.)
Public propertyIsBsonMinKey
Tests whether this BsonValue is a BsonMinKey.
(Inherited from BsonValue.)
Public propertyIsBsonNull
Tests whether this BsonValue is a BsonNull.
(Inherited from BsonValue.)
Public propertyIsBsonRegularExpression
Tests whether this BsonValue is a BsonRegularExpression.
(Inherited from BsonValue.)
Public propertyIsBsonSymbol
Tests whether this BsonValue is a BsonSymbol .
(Inherited from BsonValue.)
Public propertyIsBsonTimestamp
Tests whether this BsonValue is a BsonTimestamp.
(Inherited from BsonValue.)
Public propertyIsBsonUndefined
Tests whether this BsonValue is a BsonUndefined.
(Inherited from BsonValue.)
Public propertyIsDateTime Obsolete.
Tests whether this BsonValue is a DateTime.
(Inherited from BsonValue.)
Public propertyIsDecimal128
Tests whether this BsonValue is a Decimal128.
(Inherited from BsonValue.)
Public propertyIsDouble
Tests whether this BsonValue is a Double.
(Inherited from BsonValue.)
Public propertyIsGuid
Tests whether this BsonValue is a Guid.
(Inherited from BsonValue.)
Public propertyIsInt32
Tests whether this BsonValue is an Int32.
(Inherited from BsonValue.)
Public propertyIsInt64
Tests whether this BsonValue is an Int64.
(Inherited from BsonValue.)
Public propertyIsNumeric
Tests whether this BsonValue is a numeric value.
(Inherited from BsonValue.)
Public propertyIsObjectId
Tests whether this BsonValue is an ObjectId .
(Inherited from BsonValue.)
Public propertyIsString
Tests whether this BsonValue is a String.
(Inherited from BsonValue.)
Public propertyIsValidDateTime
Tests whether this BsonValue is a valid DateTime.
(Inherited from BsonValue.)
Public propertyItemInt32
Gets or sets a value by position.
(Inherited from BsonDocument.)
Public propertyItemString
Gets or sets a value by name.
(Inherited from BsonDocument.)
Public propertyItemString, BsonValue Obsolete.
Gets the value of an element or a default value if the element is not found.
(Inherited from BsonDocument.)
Public propertyNames
Gets the element names.
(Inherited from BsonDocument.)
Public propertyRawValue Obsolete.
Gets the raw value of this BsonValue (or null if this BsonValue doesn't have a single scalar value).
(Inherited from BsonValue.)
Public propertyRawValues Obsolete.
Gets the raw values (see BsonValue.RawValue).
(Inherited from BsonDocument.)
Public propertyValues
Gets the values.
(Inherited from BsonDocument.)
Top
Methods
  NameDescription
Public methodAdd(BsonElement)
Adds an element to the document.
(Inherited from BsonDocument.)
Public methodAdd(BsonElement) Obsolete.
Adds a list of elements to the document.
(Inherited from BsonDocument.)
Public methodAdd(DictionaryString, Object) Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.)
Public methodAdd(IDictionary) Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.)
Public methodAdd(IDictionaryString, Object) Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.)
Public methodAdd(IEnumerableBsonElement) Obsolete.
Adds a list of elements to the document.
(Inherited from BsonDocument.)
Public methodAdd(DictionaryString, Object, IEnumerableString) Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.)
Public methodAdd(IDictionary, IEnumerable) Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.)
Public methodAdd(IDictionaryString, Object, IEnumerableString) Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.)
Public methodAdd(String, BsonValue)
Creates and adds an element to the document.
(Inherited from BsonDocument.)
Public methodAdd(String, BsonValue, Boolean)
Creates and adds an element to the document, but only if the condition is true.
(Inherited from BsonDocument.)
Public methodAdd(String, FuncBsonValue, Boolean)
Creates and adds an element to the document, but only if the condition is true. If the condition is false the value factory is not called at all.
(Inherited from BsonDocument.)
Public methodAddRange(DictionaryString, Object)
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.)
Public methodAddRange(IDictionary)
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.)
Public methodAddRange(IEnumerableBsonElement)
Adds a list of elements to the document.
(Inherited from BsonDocument.)
Public methodAddRange(IEnumerableKeyValuePairString, Object)
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.)
Public methodClear
Clears the document (removes all elements).
(Inherited from BsonDocument.)
Public methodClone
Creates a shallow clone of the document (see also DeepClone).
(Inherited from BsonDocument.)
Public methodCompareTo(BsonDocument)
Compares this document to another document.
(Inherited from BsonDocument.)
Public methodCompareTo(BsonValue)
Compares the BsonDocument to another BsonValue.
(Inherited from BsonDocument.)
Public methodCompareTypeTo
Compares the type of this BsonValue to the type of another BsonValue.
(Inherited from BsonValue.)
Public methodContains
Tests whether the document contains an element with the specified name.
(Inherited from BsonDocument.)
Public methodContainsValue
Tests whether the document contains an element with the specified value.
(Inherited from BsonDocument.)
Public methodDeepClone
Creates a deep clone of the document (see also Clone).
(Inherited from BsonDocument.)
Public methodEquals(BsonDocument)
Compares this document to another document.
(Inherited from BsonDocument.)
Public methodEquals(BsonValue)
Compares this BsonValue to another BsonValue.
(Inherited from BsonValue.)
Public methodEquals(Object)
Compares this BsonDocument to another object.
(Inherited from BsonDocument.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetElement(Int32)
Gets an element of this document.
(Inherited from BsonDocument.)
Public methodGetElement(String)
Gets an element of this document.
(Inherited from BsonDocument.)
Public methodGetEnumerator
Gets an enumerator that can be used to enumerate the elements of this document.
(Inherited from BsonDocument.)
Public methodGetHashCode
Gets the hash code.
(Inherited from BsonDocument.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue(Int32)
Gets the value of an element.
(Inherited from BsonDocument.)
Public methodGetValue(String)
Gets the value of an element.
(Inherited from BsonDocument.)
Public methodGetValue(String, BsonValue)
Gets the value of an element or a default value if the element is not found.
(Inherited from BsonDocument.)
Protected methodIConvertibleGetTypeCodeImplementation
Implementation of the IConvertible GetTypeCode method.
(Inherited from BsonValue.)
Protected methodIConvertibleToBooleanImplementation
Implementation of the IConvertible ToBoolean method.
(Inherited from BsonValue.)
Protected methodIConvertibleToByteImplementation
Implementation of the IConvertible ToByte method.
(Inherited from BsonValue.)
Protected methodIConvertibleToCharImplementation
Implementation of the IConvertible ToChar method.
(Inherited from BsonValue.)
Protected methodIConvertibleToDateTimeImplementation
Implementation of the IConvertible ToDateTime method.
(Inherited from BsonValue.)
Protected methodIConvertibleToDecimalImplementation
Implementation of the IConvertible ToDecimal method.
(Inherited from BsonValue.)
Protected methodIConvertibleToDoubleImplementation
Implementation of the IConvertible ToDouble method.
(Inherited from BsonValue.)
Protected methodIConvertibleToInt16Implementation
Implementation of the IConvertible ToInt16 method.
(Inherited from BsonValue.)
Protected methodIConvertibleToInt32Implementation
Implementation of the IConvertible ToInt32 method.
(Inherited from BsonValue.)
Protected methodIConvertibleToInt64Implementation
Implementation of the IConvertible ToInt64 method.
(Inherited from BsonValue.)
Protected methodIConvertibleToSByteImplementation
Implementation of the IConvertible ToSByte method.
(Inherited from BsonValue.)
Protected methodIConvertibleToSingleImplementation
Implementation of the IConvertible ToSingle method.
(Inherited from BsonValue.)
Protected methodIConvertibleToStringImplementation
Implementation of the IConvertible ToString method.
(Inherited from BsonValue.)
Protected methodIConvertibleToUInt16Implementation
Implementation of the IConvertible ToUInt16 method.
(Inherited from BsonValue.)
Protected methodIConvertibleToUInt32Implementation
Implementation of the IConvertible ToUInt32 method.
(Inherited from BsonValue.)
Protected methodIConvertibleToUInt64Implementation
Implementation of the IConvertible ToUInt64 method.
(Inherited from BsonValue.)
Public methodIndexOfName
Gets the index of an element.
(Inherited from BsonDocument.)
Public methodInsertAt
Inserts a new element at a specified position.
(Inherited from BsonDocument.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMerge(BsonDocument)
Merges another document into this one. Existing elements are not overwritten.
(Inherited from BsonDocument.)
Public methodMerge(BsonDocument, Boolean)
Merges another document into this one, specifying whether existing elements are overwritten.
(Inherited from BsonDocument.)
Protected methodOperatorEqualsImplementation
Implementation of operator ==.
(Inherited from BsonValue.)
Public methodRemove
Removes an element from this document (if duplicate element names are allowed then all elements with this name will be removed).
(Inherited from BsonDocument.)
Public methodRemoveAt
Removes an element from this document.
(Inherited from BsonDocument.)
Public methodRemoveElement
Removes an element from this document.
(Inherited from BsonDocument.)
Public methodSet(Int32, BsonValue)
Sets the value of an element.
(Inherited from BsonDocument.)
Public methodSet(String, BsonValue)
Sets the value of an element (an element will be added if no element with this name is found).
(Inherited from BsonDocument.)
Public methodSetElement(BsonElement)
Sets an element of the document (replaces any existing element with the same name or adds a new element if an element with the same name is not found).
(Inherited from BsonDocument.)
Public methodSetElement(Int32, BsonElement)
Sets an element of the document (replacing the existing element at that position).
(Inherited from BsonDocument.)
Public methodToBoolean
Converts this BsonValue to a Boolean (using the JavaScript definition of truthiness).
(Inherited from BsonValue.)
Public methodToDecimal
Converts this BsonValue to a Decimal.
(Inherited from BsonValue.)
Public methodToDecimal128
Converts this BsonValue to a Decimal128.
(Inherited from BsonValue.)
Public methodToDictionary
Converts the BsonDocument to a Dictionary<string, object>.
(Inherited from BsonDocument.)
Public methodToDouble
Converts this BsonValue to a Double.
(Inherited from BsonValue.)
Public methodToHashtable
Converts the BsonDocument to a Hashtable.
(Inherited from BsonDocument.)
Public methodToInt32
Converts this BsonValue to an Int32.
(Inherited from BsonValue.)
Public methodToInt64
Converts this BsonValue to an Int64.
(Inherited from BsonValue.)
Public methodToLocalTime
Converts this BsonValue to a DateTime in local time.
(Inherited from BsonValue.)
Public methodToNullableLocalTime
Converts this BsonValue to a DateTime? in local time.
(Inherited from BsonValue.)
Public methodToNullableUniversalTime
Converts this BsonValue to a DateTime? in UTC.
(Inherited from BsonValue.)
Public methodToString
Returns a string representation of the document.
(Inherited from BsonDocument.)
Public methodToUniversalTime
Converts this BsonValue to a DateTime in UTC.
(Inherited from BsonValue.)
Public methodTryGetElement
Tries to get an element of this document.
(Inherited from BsonDocument.)
Public methodTryGetValue
Tries to get the value of an element of this document.
(Inherited from BsonDocument.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also