BsonValue Class |
Represents a BSON value (this is an abstract class, see the various subclasses).
Inheritance HierarchyNamespace: MongoDB.Bson
Assembly: MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
SyntaxThe BsonValue type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | AsBoolean |
Casts the BsonValue to a Boolean (throws an InvalidCastException if the cast is not valid).
|
| AsBsonArray |
Casts the BsonValue to a BsonArray (throws an InvalidCastException if the cast is not valid).
|
| AsBsonBinaryData |
Casts the BsonValue to a BsonBinaryData (throws an InvalidCastException if the cast is not valid).
|
| AsBsonDateTime |
Casts the BsonValue to a BsonDateTime (throws an InvalidCastException if the cast is not valid).
|
| AsBsonDocument |
Casts the BsonValue to a BsonDocument (throws an InvalidCastException if the cast is not valid).
|
| AsBsonJavaScript |
Casts the BsonValue to a BsonJavaScript (throws an InvalidCastException if the cast is not valid).
|
| AsBsonJavaScriptWithScope |
Casts the BsonValue to a BsonJavaScriptWithScope (throws an InvalidCastException if the cast is not valid).
|
| AsBsonMaxKey |
Casts the BsonValue to a BsonMaxKey (throws an InvalidCastException if the cast is not valid).
|
| AsBsonMinKey |
Casts the BsonValue to a BsonMinKey (throws an InvalidCastException if the cast is not valid).
|
| AsBsonNull |
Casts the BsonValue to a BsonNull (throws an InvalidCastException if the cast is not valid).
|
| AsBsonRegularExpression |
Casts the BsonValue to a BsonRegularExpression (throws an InvalidCastException if the cast is not valid).
|
| AsBsonSymbol |
Casts the BsonValue to a BsonSymbol (throws an InvalidCastException if the cast is not valid).
|
| AsBsonTimestamp |
Casts the BsonValue to a BsonTimestamp (throws an InvalidCastException if the cast is not valid).
|
| AsBsonUndefined |
Casts the BsonValue to a BsonUndefined (throws an InvalidCastException if the cast is not valid).
|
| AsBsonValue |
Casts the BsonValue to a BsonValue (a way of upcasting subclasses of BsonValue to BsonValue at compile time).
|
| AsByteArray |
Casts the BsonValue to a Byte[] (throws an InvalidCastException if the cast is not valid).
|
| AsDateTime | Obsolete.
Casts the BsonValue to a DateTime in UTC (throws an InvalidCastException if the cast is not valid).
|
| AsDecimal |
Casts the BsonValue to a Decimal (throws an InvalidCastException if the cast is not valid).
|
| AsDecimal128 |
Casts the BsonValue to a Decimal128 (throws an InvalidCastException if the cast is not valid).
|
| AsDouble |
Casts the BsonValue to a Double (throws an InvalidCastException if the cast is not valid).
|
| AsGuid |
Casts the BsonValue to a Guid (throws an InvalidCastException if the cast is not valid).
|
| AsInt32 |
Casts the BsonValue to an Int32 (throws an InvalidCastException if the cast is not valid).
|
| AsInt64 |
Casts the BsonValue to a Int64 (throws an InvalidCastException if the cast is not valid).
|
| AsLocalTime | Obsolete.
Casts the BsonValue to a DateTime in the local timezone (throws an InvalidCastException if the cast is not valid).
|
| AsNullableBoolean |
Casts the BsonValue to a Nullable{Boolean} (throws an InvalidCastException if the cast is not valid).
|
| AsNullableDateTime | Obsolete.
Casts the BsonValue to a Nullable{DateTime} (throws an InvalidCastException if the cast is not valid).
|
| AsNullableDecimal |
Casts the BsonValue to a Nullable{Decimal} (throws an InvalidCastException if the cast is not valid).
|
| AsNullableDecimal128 |
Casts the BsonValue to a Nullable{Decimal128} (throws an InvalidCastException if the cast is not valid).
|
| AsNullableDouble |
Casts the BsonValue to a Nullable{Double} (throws an InvalidCastException if the cast is not valid).
|
| AsNullableGuid |
Casts the BsonValue to a Nullable{Guid} (throws an InvalidCastException if the cast is not valid).
|
| AsNullableInt32 |
Casts the BsonValue to a Nullable{Int32} (throws an InvalidCastException if the cast is not valid).
|
| AsNullableInt64 |
Casts the BsonValue to a Nullable{Int64} (throws an InvalidCastException if the cast is not valid).
|
| AsNullableObjectId |
Casts the BsonValue to a Nullable{ObjectId} (throws an InvalidCastException if the cast is not valid).
|
| AsObjectId |
Casts the BsonValue to an ObjectId (throws an InvalidCastException if the cast is not valid).
|
| AsRegex |
Casts the BsonValue to a Regex (throws an InvalidCastException if the cast is not valid).
|
| AsString |
Casts the BsonValue to a String (throws an InvalidCastException if the cast is not valid).
|
| AsUniversalTime | Obsolete.
Casts the BsonValue to a DateTime in UTC (throws an InvalidCastException if the cast is not valid).
|
| BsonType |
Gets the BsonType of this BsonValue.
|
| IsBoolean |
Tests whether this BsonValue is a Boolean.
|
| IsBsonArray |
Tests whether this BsonValue is a BsonArray.
|
| IsBsonBinaryData |
Tests whether this BsonValue is a BsonBinaryData.
|
| IsBsonDateTime |
Tests whether this BsonValue is a BsonDateTime.
|
| IsBsonDocument |
Tests whether this BsonValue is a BsonDocument.
|
| IsBsonJavaScript |
Tests whether this BsonValue is a BsonJavaScript.
|
| IsBsonJavaScriptWithScope |
Tests whether this BsonValue is a BsonJavaScriptWithScope.
|
| IsBsonMaxKey |
Tests whether this BsonValue is a BsonMaxKey.
|
| IsBsonMinKey |
Tests whether this BsonValue is a BsonMinKey.
|
| IsBsonNull |
Tests whether this BsonValue is a BsonNull.
|
| IsBsonRegularExpression |
Tests whether this BsonValue is a BsonRegularExpression.
|
| IsBsonSymbol |
Tests whether this BsonValue is a BsonSymbol .
|
| IsBsonTimestamp |
Tests whether this BsonValue is a BsonTimestamp.
|
| IsBsonUndefined |
Tests whether this BsonValue is a BsonUndefined.
|
| IsDateTime | Obsolete.
Tests whether this BsonValue is a DateTime.
|
| IsDecimal128 |
Tests whether this BsonValue is a Decimal128.
|
| IsDouble |
Tests whether this BsonValue is a Double.
|
| IsGuid |
Tests whether this BsonValue is a Guid.
|
| IsInt32 |
Tests whether this BsonValue is an Int32.
|
| IsInt64 |
Tests whether this BsonValue is an Int64.
|
| IsNumeric |
Tests whether this BsonValue is a numeric value.
|
| IsObjectId |
Tests whether this BsonValue is an ObjectId .
|
| IsString |
Tests whether this BsonValue is a String.
|
| IsValidDateTime |
Tests whether this BsonValue is a valid DateTime.
|
| Item[Int32] |
Gets or sets a value by position (only applies to BsonDocument and BsonArray).
|
| Item[String] |
Gets or sets a value by name (only applies to BsonDocument).
|
| RawValue | Obsolete.
Gets the raw value of this BsonValue (or null if this BsonValue doesn't have a single scalar value).
|
Methods| Name | Description | |
|---|---|---|
 | Clone |
Creates a shallow clone of the BsonValue (see also DeepClone).
|
| CompareTo |
Compares this BsonValue to another BsonValue.
|
| CompareTypeTo |
Compares the type of this BsonValue to the type of another BsonValue.
|
 | Create |
Creates a new instance of the BsonValue class.
|
| DeepClone |
Creates a deep clone of the BsonValue (see also Clone).
|
| Equals(Object) |
Compares this BsonValue to another object.
(Overrides Object.Equals(Object).) |
| Equals(BsonValue) |
Compares this BsonValue to another 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.) |
| GetHashCode |
Gets the hash code.
(Overrides Object.GetHashCode().) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IConvertibleGetTypeCodeImplementation |
Implementation of the IConvertible GetTypeCode method.
|
| IConvertibleToBooleanImplementation |
Implementation of the IConvertible ToBoolean method.
|
| IConvertibleToByteImplementation |
Implementation of the IConvertible ToByte method.
|
| IConvertibleToCharImplementation |
Implementation of the IConvertible ToChar method.
|
| IConvertibleToDateTimeImplementation |
Implementation of the IConvertible ToDateTime method.
|
| IConvertibleToDecimalImplementation |
Implementation of the IConvertible ToDecimal method.
|
| IConvertibleToDoubleImplementation |
Implementation of the IConvertible ToDouble method.
|
| IConvertibleToInt16Implementation |
Implementation of the IConvertible ToInt16 method.
|
| IConvertibleToInt32Implementation |
Implementation of the IConvertible ToInt32 method.
|
| IConvertibleToInt64Implementation |
Implementation of the IConvertible ToInt64 method.
|
| IConvertibleToSByteImplementation |
Implementation of the IConvertible ToSByte method.
|
| IConvertibleToSingleImplementation |
Implementation of the IConvertible ToSingle method.
|
| IConvertibleToStringImplementation |
Implementation of the IConvertible ToString method.
|
| IConvertibleToUInt16Implementation |
Implementation of the IConvertible ToUInt16 method.
|
| IConvertibleToUInt32Implementation |
Implementation of the IConvertible ToUInt32 method.
|
| IConvertibleToUInt64Implementation |
Implementation of the IConvertible ToUInt64 method.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OperatorEqualsImplementation |
Implementation of operator ==.
|
| ToBoolean |
Converts this BsonValue to a Boolean (using the JavaScript definition of truthiness).
|
| ToDecimal |
Converts this BsonValue to a Decimal.
|
| ToDecimal128 |
Converts this BsonValue to a Decimal128.
|
| ToDouble |
Converts this BsonValue to a Double.
|
| ToInt32 |
Converts this BsonValue to an Int32.
|
| ToInt64 |
Converts this BsonValue to an Int64.
|
| ToLocalTime |
Converts this BsonValue to a DateTime in local time.
|
| ToNullableLocalTime |
Converts this BsonValue to a DateTime? in local time.
|
| ToNullableUniversalTime |
Converts this BsonValue to a DateTime? in UTC.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ToUniversalTime |
Converts this BsonValue to a DateTime in UTC.
|
Operators| Name | Description | |
|---|---|---|
 | Equality |
Compares two BsonValues.
|
| Explicit(BsonValue to Boolean) |
Casts a BsonValue to a bool.
|
| Explicit(BsonValue to Nullable<Boolean>) |
Casts a BsonValue to a bool?.
|
| Explicit(BsonValue toByte[]) |
Casts a BsonValue to a byte[].
|
| Explicit(BsonValue to DateTime) |
Casts a BsonValue to a DateTime.
|
| Explicit(BsonValue to Nullable<DateTime>) |
Casts a BsonValue to a DateTime?.
|
| Explicit(BsonValue to Decimal) |
Casts a BsonValue to a decimal.
|
| Explicit(BsonValue to Nullable<Decimal>) |
Casts a BsonValue to a decimal?.
|
| Explicit(BsonValue to Decimal128) |
Casts a BsonValue to a Decimal128.
|
| Explicit(BsonValue to Nullable<Decimal128>) |
Casts a BsonValue to a nullable Decimal128?.
|
| Explicit(BsonValue to Double) |
Casts a BsonValue to a double.
|
| Explicit(BsonValue to Nullable<Double>) |
Casts a BsonValue to a double?.
|
| Explicit(BsonValue to Guid) |
Casts a BsonValue to a Guid.
|
| Explicit(BsonValue to Nullable<Guid>) |
Casts a BsonValue to a Guid?.
|
| Explicit(BsonValue to Int32) |
Casts a BsonValue to an int.
|
| Explicit(BsonValue to Nullable<Int32>) |
Casts a BsonValue to an int?.
|
| Explicit(BsonValue to Int64) |
Casts a BsonValue to a long.
|
| Explicit(BsonValue to Nullable<Int64>) |
Casts a BsonValue to a long?.
|
| Explicit(BsonValue to ObjectId) |
Casts a BsonValue to an ObjectId.
|
| Explicit(BsonValue to Nullable<ObjectId>) |
Casts a BsonValue to an ObjectId?.
|
| Explicit(BsonValue to Regex) |
Casts a BsonValue to a Regex.
|
| Explicit(BsonValue to String) |
Casts a BsonValue to a string.
|
| GreaterThan |
Compares two BsonValues.
|
| GreaterThanOrEqual |
Compares two BsonValues.
|
| Implicit(Boolean to BsonValue) |
Converts a bool to a BsonValue.
|
| Implicit(Byte[] to BsonValue) |
Converts a byte[] to a BsonValue.
|
| Implicit(DateTime to BsonValue) |
Converts a DateTime to a BsonValue.
|
| Implicit(Decimal to BsonValue) |
Converts a decimal to a BsonValue.
|
| Implicit(Double to BsonValue) |
Converts a double to a BsonValue.
|
| Implicit(Enum to BsonValue) |
Converts an Enum to a BsonValue.
|
| Implicit(Guid to BsonValue) | Obsolete.
Converts a Guid to a BsonValue.
|
| Implicit(Int32 to BsonValue) |
Converts an int to a BsonValue.
|
| Implicit(Int64 to BsonValue) |
Converts a long to a BsonValue.
|
| Implicit(Nullable<Boolean> to BsonValue) |
Converts a bool? to a BsonValue.
|
| Implicit(Nullable<DateTime> to BsonValue) |
Converts a DateTime? to a BsonValue.
|
| Implicit(Nullable<Decimal> to BsonValue) |
Converts a decimal? to a BsonValue.
|
| Implicit(Nullable<Double> to BsonValue) |
Converts a double? to a BsonValue.
|
| Implicit(Nullable<Guid> to BsonValue) | Obsolete.
Converts a Guid? to a BsonValue.
|
| Implicit(Nullable<Int32> to BsonValue) |
Converts an int? to a BsonValue.
|
| Implicit(Nullable<Int64> to BsonValue) |
Converts a long? to a BsonValue.
|
| Implicit(String to BsonValue) |
Converts a string to a BsonValue.
|
| Implicit(Regex to BsonValue) |
Converts a Regex to a BsonValue.
|
| Implicit(Decimal128 to BsonValue) |
Converts a Decimal128 to a BsonValue.
|
| Implicit(Nullable<Decimal128> to BsonValue) |
Converts a nullable Decimal128 to a BsonValue.
|
| Implicit(ObjectId to BsonValue) |
Converts an ObjectId to a BsonValue.
|
| Implicit(Nullable<ObjectId> to BsonValue) |
Converts an ObjectId? to a BsonValue.
|
| Inequality |
Compares two BsonValues.
|
| LessThan |
Compares two BsonValues.
|
| LessThanOrEqual |
Compares two BsonValues.
|
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 AlsoReference
Inheritance HierarchySystem.Object
MongoDB.Bson.BsonValue
MongoDB.Bson.BsonArray
MongoDB.Bson.BsonBinaryData
MongoDB.Bson.BsonBoolean
MongoDB.Bson.BsonDateTime
MongoDB.Bson.BsonDecimal128
MongoDB.Bson.BsonDocument
MongoDB.Bson.BsonDouble
MongoDB.Bson.BsonInt32
MongoDB.Bson.BsonInt64
MongoDB.Bson.BsonJavaScript
MongoDB.Bson.BsonMaxKey
MongoDB.Bson.BsonMinKey
MongoDB.Bson.BsonNull
MongoDB.Bson.BsonObjectId
MongoDB.Bson.BsonRegularExpression
MongoDB.Bson.BsonString
MongoDB.Bson.BsonSymbol
MongoDB.Bson.BsonTimestamp
MongoDB.Bson.BsonUndefined
MongoDB.Bson.BsonValue
MongoDB.Bson.BsonArray
MongoDB.Bson.BsonBinaryData
MongoDB.Bson.BsonBoolean
MongoDB.Bson.BsonDateTime
MongoDB.Bson.BsonDecimal128
MongoDB.Bson.BsonDocument
MongoDB.Bson.BsonDouble
MongoDB.Bson.BsonInt32
MongoDB.Bson.BsonInt64
MongoDB.Bson.BsonJavaScript
MongoDB.Bson.BsonMaxKey
MongoDB.Bson.BsonMinKey
MongoDB.Bson.BsonNull
MongoDB.Bson.BsonObjectId
MongoDB.Bson.BsonRegularExpression
MongoDB.Bson.BsonString
MongoDB.Bson.BsonSymbol
MongoDB.Bson.BsonTimestamp
MongoDB.Bson.BsonUndefined