IndexKeysDocument Class |
Represents a BSON document that can be used where an IMongoIndexKeys is expected.
Inheritance HierarchyNamespace: MongoDB.Driver
Assembly: MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.13.1-v2-13-x1+a7f8afe27855f38f4f72157d11ba2ae73895502e
SyntaxThe IndexKeysDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | IndexKeysDocument |
Initializes a new instance of the IndexKeysDocument class.
|
| IndexKeysDocument(Boolean) |
Initializes a new instance of the IndexKeysDocument class specifying whether duplicate element names are allowed
(allowing duplicate element names is not recommended).
|
| IndexKeysDocument(DictionaryString, Object) |
Initializes a new instance of the IndexKeysDocument class and adds new elements from a dictionary of key/value pairs.
|
| IndexKeysDocument(IEnumerableKeyValuePairString, Object) |
Initializes a new instance of the IndexKeysDocument class and adds new elements from a dictionary of key/value pairs.
|
| IndexKeysDocument(IDictionary) |
Initializes a new instance of the IndexKeysDocument class and adds new elements from a dictionary of key/value pairs.
|
| IndexKeysDocument(BsonElement) |
Initializes a new instance of the IndexKeysDocument class and adds one element.
|
| IndexKeysDocument(BsonElement) | Obsolete.
Initializes a new instance of the IndexKeysDocument class and adds one or more elements.
|
| IndexKeysDocument(IEnumerableBsonElement) |
Initializes a new instance of the IndexKeysDocument class and adds new elements from a list of elements.
|
| IndexKeysDocument(DictionaryString, Object, IEnumerableString) | Obsolete.
Initializes a new instance of the IndexKeysDocument class and adds new elements from a dictionary of key/value pairs.
|
| IndexKeysDocument(IDictionaryString, Object, IEnumerableString) | Obsolete.
Initializes a new instance of the IndexKeysDocument class and adds new elements from a dictionary of key/value pairs.
|
| IndexKeysDocument(IDictionary, IEnumerable) | Obsolete.
Initializes a new instance of the IndexKeysDocument class and adds new elements from a dictionary of key/value pairs.
|
| IndexKeysDocument(String, BsonValue) |
Initializes a new instance of the IndexKeysDocument class and creates and adds a new element.
|
Properties| Name | Description | |
|---|---|---|
 | AllowDuplicateNames |
Gets or sets whether to allow duplicate names (allowing duplicate names is not recommended).
(Inherited from BsonDocument.) |
| AsBoolean |
Casts the BsonValue to a Boolean (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonArray |
Casts the BsonValue to a BsonArray (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonBinaryData |
Casts the BsonValue to a BsonBinaryData (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonDateTime |
Casts the BsonValue to a BsonDateTime (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonDocument |
Casts the BsonValue to a BsonDocument (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonJavaScript |
Casts the BsonValue to a BsonJavaScript (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonJavaScriptWithScope |
Casts the BsonValue to a BsonJavaScriptWithScope (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonMaxKey |
Casts the BsonValue to a BsonMaxKey (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonMinKey |
Casts the BsonValue to a BsonMinKey (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonNull |
Casts the BsonValue to a BsonNull (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonRegularExpression |
Casts the BsonValue to a BsonRegularExpression (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonSymbol |
Casts the BsonValue to a BsonSymbol (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonTimestamp |
Casts the BsonValue to a BsonTimestamp (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonUndefined |
Casts the BsonValue to a BsonUndefined (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsBsonValue |
Casts the BsonValue to a BsonValue (a way of upcasting subclasses of BsonValue to BsonValue at compile time).
(Inherited from BsonValue.) |
| AsByteArray |
Casts the BsonValue to a Byte[] (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsDateTime | Obsolete.
Casts the BsonValue to a DateTime in UTC (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsDecimal |
Casts the BsonValue to a Decimal (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsDecimal128 |
Casts the BsonValue to a Decimal128 (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsDouble |
Casts the BsonValue to a Double (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsGuid |
Casts the BsonValue to a Guid (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsInt32 |
Casts the BsonValue to an Int32 (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsInt64 |
Casts the BsonValue to a Int64 (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsLocalTime | Obsolete.
Casts the BsonValue to a DateTime in the local timezone (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsNullableBoolean |
Casts the BsonValue to a Nullable{Boolean} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsNullableDateTime | Obsolete.
Casts the BsonValue to a Nullable{DateTime} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsNullableDecimal |
Casts the BsonValue to a Nullable{Decimal} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsNullableDecimal128 |
Casts the BsonValue to a Nullable{Decimal128} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsNullableDouble |
Casts the BsonValue to a Nullable{Double} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsNullableGuid |
Casts the BsonValue to a Nullable{Guid} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsNullableInt32 |
Casts the BsonValue to a Nullable{Int32} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsNullableInt64 |
Casts the BsonValue to a Nullable{Int64} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsNullableObjectId |
Casts the BsonValue to a Nullable{ObjectId} (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsObjectId |
Casts the BsonValue to an ObjectId (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsRegex |
Casts the BsonValue to a Regex (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsString |
Casts the BsonValue to a String (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| AsUniversalTime | Obsolete.
Casts the BsonValue to a DateTime in UTC (throws an InvalidCastException if the cast is not valid).
(Inherited from BsonValue.) |
| BsonType |
Gets the BsonType of this BsonValue.
(Inherited from BsonDocument.) |
| ElementCount |
Gets the number of elements.
(Inherited from BsonDocument.) |
| Elements |
Gets the elements.
(Inherited from BsonDocument.) |
| IsBoolean |
Tests whether this BsonValue is a Boolean.
(Inherited from BsonValue.) |
| IsBsonArray |
Tests whether this BsonValue is a BsonArray.
(Inherited from BsonValue.) |
| IsBsonBinaryData |
Tests whether this BsonValue is a BsonBinaryData.
(Inherited from BsonValue.) |
| IsBsonDateTime |
Tests whether this BsonValue is a BsonDateTime.
(Inherited from BsonValue.) |
| IsBsonDocument |
Tests whether this BsonValue is a BsonDocument.
(Inherited from BsonValue.) |
| IsBsonJavaScript |
Tests whether this BsonValue is a BsonJavaScript.
(Inherited from BsonValue.) |
| IsBsonJavaScriptWithScope |
Tests whether this BsonValue is a BsonJavaScriptWithScope.
(Inherited from BsonValue.) |
| IsBsonMaxKey |
Tests whether this BsonValue is a BsonMaxKey.
(Inherited from BsonValue.) |
| IsBsonMinKey |
Tests whether this BsonValue is a BsonMinKey.
(Inherited from BsonValue.) |
| IsBsonNull |
Tests whether this BsonValue is a BsonNull.
(Inherited from BsonValue.) |
| IsBsonRegularExpression |
Tests whether this BsonValue is a BsonRegularExpression.
(Inherited from BsonValue.) |
| IsBsonSymbol |
Tests whether this BsonValue is a BsonSymbol .
(Inherited from BsonValue.) |
| IsBsonTimestamp |
Tests whether this BsonValue is a BsonTimestamp.
(Inherited from BsonValue.) |
| IsBsonUndefined |
Tests whether this BsonValue is a BsonUndefined.
(Inherited from BsonValue.) |
| IsDateTime | Obsolete.
Tests whether this BsonValue is a DateTime.
(Inherited from BsonValue.) |
| IsDecimal128 |
Tests whether this BsonValue is a Decimal128.
(Inherited from BsonValue.) |
| IsDouble |
Tests whether this BsonValue is a Double.
(Inherited from BsonValue.) |
| IsGuid |
Tests whether this BsonValue is a Guid.
(Inherited from BsonValue.) |
| IsInt32 |
Tests whether this BsonValue is an Int32.
(Inherited from BsonValue.) |
| IsInt64 |
Tests whether this BsonValue is an Int64.
(Inherited from BsonValue.) |
| IsNumeric |
Tests whether this BsonValue is a numeric value.
(Inherited from BsonValue.) |
| IsObjectId |
Tests whether this BsonValue is an ObjectId .
(Inherited from BsonValue.) |
| IsString |
Tests whether this BsonValue is a String.
(Inherited from BsonValue.) |
| IsValidDateTime |
Tests whether this BsonValue is a valid DateTime.
(Inherited from BsonValue.) |
| ItemInt32 |
Gets or sets a value by position.
(Inherited from BsonDocument.) |
| ItemString |
Gets or sets a value by name.
(Inherited from BsonDocument.) |
| ItemString, BsonValue | Obsolete.
Gets the value of an element or a default value if the element is not found.
(Inherited from BsonDocument.) |
| Names |
Gets the element names.
(Inherited from BsonDocument.) |
| RawValue | Obsolete.
Gets the raw value of this BsonValue (or null if this BsonValue doesn't have a single scalar value).
(Inherited from BsonValue.) |
| RawValues | Obsolete.
Gets the raw values (see BsonValue.RawValue).
(Inherited from BsonDocument.) |
| Values |
Gets the values.
(Inherited from BsonDocument.) |
Methods| Name | Description | |
|---|---|---|
| Add(DictionaryString, Object) | Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.) |
| Add(IDictionaryString, Object) | Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.) |
| Add(IDictionary) | Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.) |
| Add(BsonElement) |
Adds an element to the document.
(Inherited from BsonDocument.) |
| Add(BsonElement) | Obsolete.
Adds a list of elements to the document.
(Inherited from BsonDocument.) |
| Add(IEnumerableBsonElement) | Obsolete.
Adds a list of elements to the document.
(Inherited from BsonDocument.) |
| Add(DictionaryString, Object, IEnumerableString) | Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.) |
| Add(IDictionaryString, Object, IEnumerableString) | Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.) |
| Add(IDictionary, IEnumerable) | Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.) |
| Add(String, BsonValue) |
Creates and adds an element to the document.
(Inherited from BsonDocument.) |
| Add(String, BsonValue, Boolean) |
Creates and adds an element to the document, but only if the condition is true.
(Inherited from BsonDocument.) |
| Add(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.) |
| AddRange(DictionaryString, Object) |
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.) |
| AddRange(IEnumerableKeyValuePairString, Object) |
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.) |
| AddRange(IDictionary) |
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from BsonDocument.) |
| AddRange(IEnumerableBsonElement) |
Adds a list of elements to the document.
(Inherited from BsonDocument.) |
| Clear |
Clears the document (removes all elements).
(Inherited from BsonDocument.) |
| Clone |
Creates a shallow clone of the document (see also DeepClone).
(Inherited from BsonDocument.) |
| CompareTo(BsonDocument) |
Compares this document to another document.
(Inherited from BsonDocument.) |
| CompareTo(BsonValue) |
Compares the BsonDocument to another BsonValue.
(Inherited from BsonDocument.) |
| CompareTypeTo |
Compares the type of this BsonValue to the type of another BsonValue.
(Inherited from BsonValue.) |
| Contains |
Tests whether the document contains an element with the specified name.
(Inherited from BsonDocument.) |
| ContainsValue |
Tests whether the document contains an element with the specified value.
(Inherited from BsonDocument.) |
| DeepClone |
Creates a deep clone of the document (see also Clone).
(Inherited from BsonDocument.) |
| Equals(Object) |
Compares this BsonDocument to another object.
(Inherited from BsonDocument.) |
| Equals(BsonDocument) |
Compares this document to another document.
(Inherited from BsonDocument.) |
| Equals(BsonValue) |
Compares this BsonValue to another BsonValue.
(Inherited from BsonValue.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetElement(Int32) |
Gets an element of this document.
(Inherited from BsonDocument.) |
| GetElement(String) |
Gets an element of this document.
(Inherited from BsonDocument.) |
| GetEnumerator |
Gets an enumerator that can be used to enumerate the elements of this document.
(Inherited from BsonDocument.) |
| GetHashCode |
Gets the hash code.
(Inherited from BsonDocument.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue(Int32) |
Gets the value of an element.
(Inherited from BsonDocument.) |
| GetValue(String) |
Gets the value of an element.
(Inherited from BsonDocument.) |
| GetValue(String, BsonValue) |
Gets the value of an element or a default value if the element is not found.
(Inherited from BsonDocument.) |
| IConvertibleGetTypeCodeImplementation |
Implementation of the IConvertible GetTypeCode method.
(Inherited from BsonValue.) |
| IConvertibleToBooleanImplementation |
Implementation of the IConvertible ToBoolean method.
(Inherited from BsonValue.) |
| IConvertibleToByteImplementation |
Implementation of the IConvertible ToByte method.
(Inherited from BsonValue.) |
| IConvertibleToCharImplementation |
Implementation of the IConvertible ToChar method.
(Inherited from BsonValue.) |
| IConvertibleToDateTimeImplementation |
Implementation of the IConvertible ToDateTime method.
(Inherited from BsonValue.) |
| IConvertibleToDecimalImplementation |
Implementation of the IConvertible ToDecimal method.
(Inherited from BsonValue.) |
| IConvertibleToDoubleImplementation |
Implementation of the IConvertible ToDouble method.
(Inherited from BsonValue.) |
| IConvertibleToInt16Implementation |
Implementation of the IConvertible ToInt16 method.
(Inherited from BsonValue.) |
| IConvertibleToInt32Implementation |
Implementation of the IConvertible ToInt32 method.
(Inherited from BsonValue.) |
| IConvertibleToInt64Implementation |
Implementation of the IConvertible ToInt64 method.
(Inherited from BsonValue.) |
| IConvertibleToSByteImplementation |
Implementation of the IConvertible ToSByte method.
(Inherited from BsonValue.) |
| IConvertibleToSingleImplementation |
Implementation of the IConvertible ToSingle method.
(Inherited from BsonValue.) |
| IConvertibleToStringImplementation |
Implementation of the IConvertible ToString method.
(Inherited from BsonValue.) |
| IConvertibleToUInt16Implementation |
Implementation of the IConvertible ToUInt16 method.
(Inherited from BsonValue.) |
| IConvertibleToUInt32Implementation |
Implementation of the IConvertible ToUInt32 method.
(Inherited from BsonValue.) |
| IConvertibleToUInt64Implementation |
Implementation of the IConvertible ToUInt64 method.
(Inherited from BsonValue.) |
| IndexOfName |
Gets the index of an element.
(Inherited from BsonDocument.) |
| InsertAt |
Inserts a new element at a specified position.
(Inherited from BsonDocument.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Merge(BsonDocument) |
Merges another document into this one. Existing elements are not overwritten.
(Inherited from BsonDocument.) |
| Merge(BsonDocument, Boolean) |
Merges another document into this one, specifying whether existing elements are overwritten.
(Inherited from BsonDocument.) |
| OperatorEqualsImplementation |
Implementation of operator ==.
(Inherited from BsonValue.) |
| Remove |
Removes an element from this document (if duplicate element names are allowed
then all elements with this name will be removed).
(Inherited from BsonDocument.) |
| RemoveAt |
Removes an element from this document.
(Inherited from BsonDocument.) |
| RemoveElement |
Removes an element from this document.
(Inherited from BsonDocument.) |
| Set(Int32, BsonValue) |
Sets the value of an element.
(Inherited from BsonDocument.) |
| Set(String, BsonValue) |
Sets the value of an element (an element will be added if no element with this name is found).
(Inherited from BsonDocument.) |
| SetElement(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.) |
| SetElement(Int32, BsonElement) |
Sets an element of the document (replacing the existing element at that position).
(Inherited from BsonDocument.) |
| ToBoolean |
Converts this BsonValue to a Boolean (using the JavaScript definition of truthiness).
(Inherited from BsonValue.) |
| ToDecimal |
Converts this BsonValue to a Decimal.
(Inherited from BsonValue.) |
| ToDecimal128 |
Converts this BsonValue to a Decimal128.
(Inherited from BsonValue.) |
| ToDictionary |
Converts the BsonDocument to a Dictionary<string, object>.
(Inherited from BsonDocument.) |
| ToDouble |
Converts this BsonValue to a Double.
(Inherited from BsonValue.) |
| ToHashtable |
Converts the BsonDocument to a Hashtable.
(Inherited from BsonDocument.) |
| ToInt32 |
Converts this BsonValue to an Int32.
(Inherited from BsonValue.) |
| ToInt64 |
Converts this BsonValue to an Int64.
(Inherited from BsonValue.) |
| ToLocalTime |
Converts this BsonValue to a DateTime in local time.
(Inherited from BsonValue.) |
| ToNullableLocalTime |
Converts this BsonValue to a DateTime? in local time.
(Inherited from BsonValue.) |
| ToNullableUniversalTime |
Converts this BsonValue to a DateTime? in UTC.
(Inherited from BsonValue.) |
| ToString |
Returns a string representation of the document.
(Inherited from BsonDocument.) |
| ToUniversalTime |
Converts this BsonValue to a DateTime in UTC.
(Inherited from BsonValue.) |
| TryGetElement |
Tries to get an element of this document.
(Inherited from BsonDocument.) |
| TryGetValue |
Tries to get the value of an element of this document.
(Inherited from BsonDocument.) |
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.) |
See Also