BsonDocumentWrapper Class |
Represents a BsonDocument wrapper.
Inheritance HierarchySystemObject
MongoDB.BsonBsonValue
MongoDB.BsonBsonDocument
MongoDB.BsonMaterializedOnDemandBsonDocument
MongoDB.BsonBsonDocumentWrapper
MongoDB.BsonBsonValue
MongoDB.BsonBsonDocument
MongoDB.BsonMaterializedOnDemandBsonDocument
MongoDB.BsonBsonDocumentWrapper
Namespace: MongoDB.Bson
Assembly: MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.8.0+cc573f3e1f48f39162b4b680e921a623e127e8fa
SyntaxThe BsonDocumentWrapper type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BsonDocumentWrapper(Object) |
Initializes a new instance of the BsonDocumentWrapper class.
|
| BsonDocumentWrapper(Object, IBsonSerializer) |
Initializes a new instance of the BsonDocumentWrapper class.
|
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 MaterializedOnDemandBsonDocument.) |
| Elements |
Gets the elements.
(Inherited from MaterializedOnDemandBsonDocument.) |
| 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.) |
| IsDisposed |
Gets a value indicating whether this instance is disposed.
(Inherited from MaterializedOnDemandBsonDocument.) |
| 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.) |
| IsMaterialized |
Gets a value indicating whether this instance is materialized.
(Inherited from MaterializedOnDemandBsonDocument.) |
| 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 MaterializedOnDemandBsonDocument.) |
| ItemString |
Gets or sets a value by name.
(Inherited from MaterializedOnDemandBsonDocument.) |
| ItemString, BsonValue | Obsolete.
Gets the value of an element or a default value if the element is not found.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Names |
Gets the element names.
(Inherited from MaterializedOnDemandBsonDocument.) |
| 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 MaterializedOnDemandBsonDocument.) |
| Serializer |
Gets the serializer.
|
| Values |
Gets the values.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Wrapped |
Gets the wrapped value.
|
Methods| Name | Description | |
|---|---|---|
| Add(DictionaryString, Object) | Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Add(IDictionaryString, Object) | Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Add(IDictionary) | Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Add(BsonElement) |
Adds an element to the document.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Add(BsonElement) | Obsolete.
Adds a list of elements to the document.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Add(IEnumerableBsonElement) | Obsolete.
Adds a list of elements to the document.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Add(DictionaryString, Object, IEnumerableString) | Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Add(IDictionaryString, Object, IEnumerableString) | Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Add(IDictionary, IEnumerable) | Obsolete.
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Add(String, BsonValue) |
Creates and adds an element to the document.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Add(String, BsonValue, Boolean) |
Creates and adds an element to the document, but only if the condition is true.
(Inherited from MaterializedOnDemandBsonDocument.) |
| 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 MaterializedOnDemandBsonDocument.) |
| AddRange(DictionaryString, Object) |
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from MaterializedOnDemandBsonDocument.) |
| AddRange(IEnumerableKeyValuePairString, Object) |
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from MaterializedOnDemandBsonDocument.) |
| AddRange(IDictionary) |
Adds elements to the document from a dictionary of key/value pairs.
(Inherited from MaterializedOnDemandBsonDocument.) |
| AddRange(IEnumerableBsonElement) |
Adds a list of elements to the document.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Clear |
Clears the document (removes all elements).
(Inherited from MaterializedOnDemandBsonDocument.) |
| Clone |
Creates a shallow clone of the document (see also DeepClone).
(Overrides MaterializedOnDemandBsonDocumentClone.) |
| CompareTo(BsonDocument) |
Compares this document to another document.
(Inherited from MaterializedOnDemandBsonDocument.) |
| CompareTo(BsonValue) |
Compares the BsonDocument to another BsonValue.
(Inherited from MaterializedOnDemandBsonDocument.) |
| 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 MaterializedOnDemandBsonDocument.) |
| ContainsValue |
Tests whether the document contains an element with the specified value.
(Inherited from MaterializedOnDemandBsonDocument.) |
 | Create(Type, Object) |
Creates a new instance of the BsonDocumentWrapper class.
|
| CreateTNominalType(TNominalType) |
Creates a new instance of the BsonDocumentWrapper class.
|
| CreateMultiple(Type, IEnumerable) |
Creates a list of new instances of the BsonDocumentWrapper class.
|
| CreateMultipleTNominalType(IEnumerableTNominalType) |
Creates a list of new instances of the BsonDocumentWrapper class.
|
| DeepClone |
Creates a deep clone of the document (see also Clone).
(Inherited from MaterializedOnDemandBsonDocument.) |
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from MaterializedOnDemandBsonDocument.) |
 | Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Equals(Object) |
Determines whether the specified Object, is equal to this instance.
(Inherited from MaterializedOnDemandBsonDocument.) |
| 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 MaterializedOnDemandBsonDocument.) |
| GetElement(String) |
Gets an element of this document.
(Inherited from MaterializedOnDemandBsonDocument.) |
| GetEnumerator |
Gets an enumerator that can be used to enumerate the elements of this document.
(Inherited from MaterializedOnDemandBsonDocument.) |
| GetHashCode |
Returns a hash code for this instance.
(Inherited from MaterializedOnDemandBsonDocument.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue(Int32) |
Gets the value of an element.
(Inherited from MaterializedOnDemandBsonDocument.) |
| GetValue(String) |
Gets the value of an element.
(Inherited from MaterializedOnDemandBsonDocument.) |
| GetValue(String, BsonValue) |
Gets the value of an element or a default value if the element is not found.
(Inherited from MaterializedOnDemandBsonDocument.) |
| 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 MaterializedOnDemandBsonDocument.) |
| Materialize |
Materializes the BsonDocument.
(Overrides MaterializedOnDemandBsonDocumentMaterialize.) |
| MaterializeCompleted |
Informs subclasses that the Materialize process completed so they can free any resources related to the unmaterialized state.
(Overrides MaterializedOnDemandBsonDocumentMaterializeCompleted.) |
| 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 MaterializedOnDemandBsonDocument.) |
| Merge(BsonDocument, Boolean) |
Merges another document into this one, specifying whether existing elements are overwritten.
(Inherited from MaterializedOnDemandBsonDocument.) |
| 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 MaterializedOnDemandBsonDocument.) |
| RemoveAt |
Removes an element from this document.
(Inherited from MaterializedOnDemandBsonDocument.) |
| RemoveElement |
Removes an element from this document.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Set(Int32, BsonValue) |
Sets the value of an element.
(Inherited from MaterializedOnDemandBsonDocument.) |
| Set(String, BsonValue) |
Sets the value of an element (an element will be added if no element with this name is found).
(Inherited from MaterializedOnDemandBsonDocument.) |
| 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 MaterializedOnDemandBsonDocument.) |
| SetElement(Int32, BsonElement) |
Sets an element of the document (replacing the existing element at that position).
(Inherited from MaterializedOnDemandBsonDocument.) |
| ThrowIfDisposed |
Throws if disposed.
(Inherited from MaterializedOnDemandBsonDocument.) |
| 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 MaterializedOnDemandBsonDocument.) |
| TryGetValue |
Tries to get the value of an element of this document.
(Inherited from MaterializedOnDemandBsonDocument.) |
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