BsonString Class |
Represents a BSON string value.
Inheritance HierarchyNamespace: MongoDB.Bson
Assembly: MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
SyntaxThe BsonString type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BsonString |
Initializes a new instance of the BsonString class.
|
Properties| Name | Description | |
|---|---|---|
 | 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.
(Overrides BsonValueBsonType.) |
 | Empty |
Gets an instance of BsonString that represents an empty string.
|
| 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 (only applies to BsonDocument and BsonArray).
(Inherited from BsonValue.) |
| ItemString |
Gets or sets a value by name (only applies to BsonDocument).
(Inherited from BsonValue.) |
| RawValue | Obsolete.
Gets the BsonString as a string.
(Overrides BsonValueRawValue.) |
| Value |
Gets the value of this BsonString.
|
Methods| Name | Description | |
|---|---|---|
| Clone |
Creates a shallow clone of the BsonValue (see also DeepClone).
(Inherited from BsonValue.) |
| CompareTo(BsonString) |
Compares this BsonString to another BsonString.
|
| CompareTo(BsonValue) |
Compares the BsonString to another BsonValue.
(Overrides BsonValueCompareTo(BsonValue).) |
| CompareTypeTo |
Compares the type of this BsonValue to the type of another BsonValue.
(Inherited from BsonValue.) |
| Create |
Creates a new BsonString.
|
| DeepClone |
Creates a deep clone of the BsonValue (see also Clone).
(Inherited from BsonValue.) |
| Equals(BsonString) |
Compares this BsonString to another BsonString.
|
| Equals(BsonValue) |
Compares this BsonValue to another BsonValue.
(Inherited from BsonValue.) |
| Equals(Object) |
Compares this BsonString to another object.
(Overrides BsonValueEquals(Object).) |
 | 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 BsonValueGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IConvertibleGetTypeCodeImplementation |
Implementation of the IConvertible GetTypeCode method.
(Overrides BsonValueIConvertibleGetTypeCodeImplementation.) |
| IConvertibleToBooleanImplementation |
Implementation of the IConvertible ToBoolean method.
(Overrides BsonValueIConvertibleToBooleanImplementation(IFormatProvider).) |
| IConvertibleToByteImplementation |
Implementation of the IConvertible ToByte method.
(Overrides BsonValueIConvertibleToByteImplementation(IFormatProvider).) |
| IConvertibleToCharImplementation |
Implementation of the IConvertible ToChar method.
(Overrides BsonValueIConvertibleToCharImplementation(IFormatProvider).) |
| IConvertibleToDateTimeImplementation |
Implementation of the IConvertible ToDateTime method.
(Overrides BsonValueIConvertibleToDateTimeImplementation(IFormatProvider).) |
| IConvertibleToDecimalImplementation |
Implementation of the IConvertible ToDecimal method.
(Overrides BsonValueIConvertibleToDecimalImplementation(IFormatProvider).) |
| IConvertibleToDoubleImplementation |
Implementation of the IConvertible ToDouble method.
(Overrides BsonValueIConvertibleToDoubleImplementation(IFormatProvider).) |
| IConvertibleToInt16Implementation |
Implementation of the IConvertible ToInt16 method.
(Overrides BsonValueIConvertibleToInt16Implementation(IFormatProvider).) |
| IConvertibleToInt32Implementation |
Implementation of the IConvertible ToInt32 method.
(Overrides BsonValueIConvertibleToInt32Implementation(IFormatProvider).) |
| IConvertibleToInt64Implementation |
Implementation of the IConvertible ToInt64 method.
(Overrides BsonValueIConvertibleToInt64Implementation(IFormatProvider).) |
| IConvertibleToSByteImplementation |
Implementation of the IConvertible ToSByte method.
(Overrides BsonValueIConvertibleToSByteImplementation(IFormatProvider).) |
| IConvertibleToSingleImplementation |
Implementation of the IConvertible ToSingle method.
(Overrides BsonValueIConvertibleToSingleImplementation(IFormatProvider).) |
| IConvertibleToStringImplementation |
Implementation of the IConvertible ToString method.
(Overrides BsonValueIConvertibleToStringImplementation(IFormatProvider).) |
| IConvertibleToUInt16Implementation |
Implementation of the IConvertible ToUInt16 method.
(Overrides BsonValueIConvertibleToUInt16Implementation(IFormatProvider).) |
| IConvertibleToUInt32Implementation |
Implementation of the IConvertible ToUInt32 method.
(Overrides BsonValueIConvertibleToUInt32Implementation(IFormatProvider).) |
| IConvertibleToUInt64Implementation |
Implementation of the IConvertible ToUInt64 method.
(Overrides BsonValueIConvertibleToUInt64Implementation(IFormatProvider).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OperatorEqualsImplementation |
Implementation of operator ==.
(Inherited from BsonValue.) |
| ToBoolean |
Converts this BsonValue to a Boolean (using the JavaScript definition of truthiness).
(Overrides BsonValueToBoolean.) |
| ToDecimal |
Converts this BsonValue to a Decimal.
(Overrides BsonValueToDecimal.) |
| ToDecimal128 |
Converts this BsonValue to a Decimal128.
(Overrides BsonValueToDecimal128.) |
| ToDouble |
Converts this BsonValue to a Double.
(Overrides BsonValueToDouble.) |
| ToInt32 |
Converts this BsonValue to an Int32.
(Overrides BsonValueToInt32.) |
| ToInt64 |
Converts this BsonValue to an Int64.
(Overrides BsonValueToInt64.) |
| 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 value.
(Overrides ObjectToString.) |
| ToUniversalTime |
Converts this BsonValue to a DateTime in UTC.
(Inherited from BsonValue.) |
Operators| Name | Description | |
|---|---|---|
 | Equality |
Compares two BsonString values.
|
| (String to BsonString) |
Converts a string to a BsonString.
|
| Inequality |
Compares two BsonString values.
|
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