BsonDocument ClassMongoDB C# Driver API Documentation
Represents a BSON document.
Inheritance Hierarchy

SystemObject
  MongoDB.BsonBsonValue
    MongoDB.BsonBsonDocument
      More...

Namespace: MongoDB.Bson
Assembly: MongoDB.Bson (in MongoDB.Bson.dll) Version: { version: '1.11.0.92', semver: '1.11.0', commit: '791a16588d4a8b3b118a8b3b57cfa436fec5d3da', commitDate: '2015-12-08 22:55:45' }
Syntax

[SerializableAttribute]
public class BsonDocument : BsonValue, 
	IBsonSerializable, IComparable<BsonDocument>, IConvertibleToBsonDocument, IEnumerable<BsonElement>, 
	IEnumerable, IEquatable<BsonDocument>

The BsonDocument type exposes the following members.

Constructors

  NameDescription
Public methodBsonDocument
Initializes a new instance of the BsonDocument class.
Public methodBsonDocument(Boolean)
Initializes a new instance of the BsonDocument class specifying whether duplicate element names are allowed (allowing duplicate element names is not recommended).
Public methodBsonDocument(DictionaryString, Object)
Initializes a new instance of the BsonDocument class and adds new elements from a dictionary of key/value pairs.
Public methodBsonDocument(IEnumerableKeyValuePairString, Object)
Initializes a new instance of the BsonDocument class and adds new elements from a dictionary of key/value pairs.
Public methodBsonDocument(IDictionary)
Initializes a new instance of the BsonDocument class and adds new elements from a dictionary of key/value pairs.
Public methodBsonDocument(BsonElement)
Initializes a new instance of the BsonDocument class and adds one element.
Public methodBsonDocument(BsonElement) Obsolete.
Initializes a new instance of the BsonDocument class and adds one or more elements.
Public methodBsonDocument(IEnumerableBsonElement)
Initializes a new instance of the BsonDocument class and adds new elements from a list of elements.
Public methodBsonDocument(DictionaryString, Object, IEnumerableString) Obsolete.
Initializes a new instance of the BsonDocument class and adds new elements from a dictionary of key/value pairs.
Public methodBsonDocument(IDictionaryString, Object, IEnumerableString) Obsolete.
Initializes a new instance of the BsonDocument class and adds new elements from a dictionary of key/value pairs.
Public methodBsonDocument(IDictionary, IEnumerable) Obsolete.
Initializes a new instance of the BsonDocument class and adds new elements from a dictionary of key/value pairs.
Public methodBsonDocument(String, BsonValue)
Initializes a new instance of the BsonDocument class and creates and adds a new element.
Top
Methods

  NameDescription
Public methodAdd(DictionaryString, Object) Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
Public methodAdd(IDictionaryString, Object) Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
Public methodAdd(IDictionary) Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
Public methodAdd(BsonElement)
Adds an element to the document.
Public methodAdd(BsonElement) Obsolete.
Adds a list of elements to the document.
Public methodAdd(IEnumerableBsonElement) Obsolete.
Adds a list of elements to the document.
Public methodAdd(DictionaryString, Object, IEnumerableString) Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
Public methodAdd(IDictionaryString, Object, IEnumerableString) Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
Public methodAdd(IDictionary, IEnumerable) Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
Public methodAdd(String, BsonValue)
Creates and adds an element to the document.
Public methodAdd(String, BsonValue, Boolean)
Creates and adds an element to the document, but only if the condition is true.
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.
Public methodAddRange(DictionaryString, Object)
Adds elements to the document from a dictionary of key/value pairs.
Public methodAddRange(IEnumerableKeyValuePairString, Object)
Adds elements to the document from a dictionary of key/value pairs.
Public methodAddRange(IDictionary)
Adds elements to the document from a dictionary of key/value pairs.
Public methodAddRange(IEnumerableBsonElement)
Adds a list of elements to the document.
Public methodClear
Clears the document (removes all elements).
Public methodClone
Creates a shallow clone of the document (see also DeepClone).
(Overrides BsonValueClone.)
Public methodCompareTo(BsonDocument)
Compares this document to another document.
Public methodCompareTo(BsonValue)
Compares the BsonDocument to another BsonValue.
(Overrides BsonValueCompareTo(BsonValue).)
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.
Public methodContainsValue
Tests whether the document contains an element with the specified value.
Public methodStatic memberCreate
Creates a new BsonDocument by mapping an object to a BsonDocument.
Public methodDeepClone
Creates a deep clone of the document (see also Clone).
(Overrides BsonValueDeepClone.)
Public methodDeserialize Obsolete.
Deserializes the document from a BsonReader.
Public methodEquals(Object)
Compares this BsonDocument to another object.
(Overrides BsonValueEquals(Object).)
Public methodEquals(BsonDocument)
Compares this document to another document.
Public methodEquals(BsonValue)
Compares this BsonValue to another BsonValue.
(Inherited from BsonValue.)
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 methodGetDocumentId Obsolete.
Gets the Id of the document.
Public methodGetElement(Int32)
Gets an element of this document.
Public methodGetElement(String)
Gets an element of this document.
Public methodGetEnumerator
Gets an enumerator that can be used to enumerate the elements of this document.
Public methodGetHashCode
Gets the hash code.
(Overrides BsonValueGetHashCode.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Public methodGetValue(Int32)
Gets the value of an element.
Public methodGetValue(String)
Gets the value of an element.
Public methodGetValue(String, BsonValue)
Gets the value of an element or a default value if the element is not found.
Public methodInsertAt
Inserts a new element at a specified position.
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.
Public methodMerge(BsonDocument, Boolean)
Merges another document into this one, specifying whether existing elements are overwritten.
Protected methodOperatorEqualsImplementation
Implementation of operator ==.
(Inherited from BsonValue.)
Public methodStatic memberParse
Parses a JSON string and returns a BsonDocument.
Public methodStatic memberReadFrom(Byte) Obsolete.
Reads a BsonDocument from a byte array.
Public methodStatic memberReadFrom(Stream) Obsolete.
Reads a BsonDocument from a stream.
Public methodStatic memberReadFrom(String) Obsolete.
Reads a BsonDocument from a file.
Public methodStatic memberReadFrom(BsonBuffer) Obsolete.
Reads a BsonDocument from a BsonBuffer.
Public methodStatic memberReadFrom(BsonReader) Obsolete.
Reads a BsonDocument from a BsonReader.
Public methodRemove
Removes an element from this document (if duplicate element names are allowed then all elements with this name will be removed).
Public methodRemoveAt
Removes an element from this document.
Public methodRemoveElement
Removes an element from this document.
Public methodSerialize Obsolete.
Serializes this document to a BsonWriter.
Public methodSet(Int32, BsonValue)
Sets the value of an element.
Public methodSet(String, BsonValue)
Sets the value of an element (an element will be added if no element with this name is found).
Public methodSetDocumentId Obsolete.
Sets the document Id.
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).
Public methodSetElement(Int32, BsonElement)
Sets an element of the document (replacing the existing element at that position).
Public methodToBoolean
Converts this BsonValue to a Boolean (using the JavaScript definition of truthiness).
(Inherited from BsonValue.)
Public methodToDictionary
Converts the BsonDocument to a Dictionary<string, object>.
Public methodToDouble
Converts this BsonValue to a Double.
(Inherited from BsonValue.)
Public methodToHashtable
Converts the BsonDocument to a Hashtable.
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.
(Overrides ObjectToString.)
Public methodToUniversalTime
Converts this BsonValue to a DateTime in UTC.
(Inherited from BsonValue.)
Public methodTryGetElement
Tries to get an element of this document.
Public methodTryGetValue
Tries to get the value of an element of this document.
Public methodWriteTo(Stream) Obsolete.
Writes the document to a Stream.
Public methodWriteTo(String) Obsolete.
Writes the document to a file.
Public methodWriteTo(BsonBuffer) Obsolete.
Writes the document to a BsonBuffer.
Public methodWriteTo(BsonWriter) Obsolete.
Writes the document to a BsonWriter.
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compares two BsonDocument values.
Public operatorStatic memberInequality
Compares two BsonDocument values.
Top
Extension Methods

  NameDescription
Public Extension MethodContainsAllBsonElement
Determines whether a sequence contains all of the specified values.
(Defined by LinqToMongo.)
Public Extension MethodContainsAnyBsonElement
Determines whether a sequence contains any of the specified values.
(Defined by LinqToMongo.)
Public Extension MethodToBson(Type)Overloaded.
Converts an object to a BSON document byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBson(Type, IBsonSerializationOptions)Overloaded.
Converts an object to a BSON document byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBson(Type, BsonBinaryWriterSettings)Overloaded.
Converts an object to a BSON document byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBson(Type, IBsonSerializationOptions, BsonBinaryWriterSettings)Overloaded.
Converts an object to a BSON document byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument(Type)Overloaded.
Converts an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument(Type, IBsonSerializationOptions)Overloaded.
Converts an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson(Type)Overloaded.
Converts an object to a JSON string.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson(Type, IBsonSerializationOptions)Overloaded.
Converts an object to a JSON string.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson(Type, JsonWriterSettings)Overloaded.
Converts an object to a JSON string.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson(Type, IBsonSerializationOptions, JsonWriterSettings)Overloaded.
Converts an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
Properties

  NameDescription
Public propertyAllowDuplicateNames
Gets or sets whether to allow duplicate names (allowing duplicate names is not recommended).
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 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 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 BsonValue.)
Public propertyElementCount
Gets the number of elements.
Public propertyElements
Gets the elements.
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 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.
(Overrides BsonValueItemInt32.)
Public propertyItemString
Gets or sets a value by name.
(Overrides BsonValueItemString.)
Public propertyItemString, BsonValue Obsolete.
Gets the value of an element or a default value if the element is not found.
Public propertyNames
Gets the element names.
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).
Public propertyValues
Gets the values.
Top
See Also

Reference

Inheritance Hierarchy

SystemObject
  MongoDB.BsonBsonValue
    MongoDB.BsonBsonDocument
      MongoDB.BsonMaterializedOnDemandBsonDocument
      MongoDB.BsonRawBsonDocument
      MongoDB.DriverCollectionOptionsDocument
      MongoDB.DriverFieldsDocument
      MongoDB.DriverGeoHaystackSearchOptionsDocument
      MongoDB.DriverGeoNearOptionsDocument
      MongoDB.DriverGroupByDocument
      MongoDB.DriverIndexKeysDocument
      MongoDB.DriverIndexOptionsDocument
      MongoDB.DriverMapReduceOptionsDocument
      MongoDB.DriverQueryDocument
      MongoDB.DriverScopeDocument
      MongoDB.DriverSortByDocument
      MongoDB.DriverUpdateDocument