BsonObjectId ClassMongoDB C# Driver API Documentation
Represents a BSON ObjectId value (see also ObjectId).
Inheritance Hierarchy

SystemObject
  MongoDB.BsonBsonValue
    MongoDB.BsonBsonObjectId

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 BsonObjectId : BsonValue, 
	IComparable<BsonObjectId>, IEquatable<BsonObjectId>

The BsonObjectId type exposes the following members.

Constructors

  NameDescription
Public methodBsonObjectId(Byte) Obsolete.
Initializes a new instance of the BsonObjectId class.
Public methodBsonObjectId(String) Obsolete.
Initializes a new instance of the BsonObjectId class.
Public methodBsonObjectId(ObjectId)
Initializes a new instance of the BsonObjectId class.
Public methodBsonObjectId(DateTime, Int32, Int16, Int32) Obsolete.
Initializes a new instance of the BsonObjectId class.
Public methodBsonObjectId(Int32, Int32, Int16, Int32) Obsolete.
Initializes a new instance of the BsonObjectId class.
Top
Methods

  NameDescription
Public methodClone
Creates a shallow clone of the BsonValue (see also DeepClone).
(Inherited from BsonValue.)
Public methodCompareTo(BsonObjectId)
Compares this BsonObjectId to another BsonObjectId.
Public methodCompareTo(BsonValue)
Compares the BsonObjectId to another BsonValue.
(Overrides BsonValueCompareTo(BsonValue).)
Public methodCompareTypeTo
Compares the type of this BsonValue to the type of another BsonValue.
(Inherited from BsonValue.)
Public methodStatic memberCreate(Byte) Obsolete.
Creates a new instance of the BsonObjectId class.
Public methodStatic memberCreate(Object)
Creates a new BsonObjectId.
Public methodStatic memberCreate(String) Obsolete.
Creates a new instance of the BsonObjectId class.
Public methodStatic memberCreate(ObjectId) Obsolete.
Creates a new instance of the BsonObjectId class.
Public methodStatic memberCreate(Int32, Int32, Int16, Int32) Obsolete.
Creates a new instance of the BsonObjectId class.
Public methodDeepClone
Creates a deep clone of the BsonValue (see also Clone).
(Inherited from BsonValue.)
Public methodEquals(Object)
Compares this BsonObjectId to another object.
(Overrides BsonValueEquals(Object).)
Public methodEquals(BsonObjectId)
Compares this BsonObjectId to another BsonObjectId.
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 methodStatic memberGenerateNewId Obsolete.
Generates a new BsonObjectId with a unique value.
Public methodStatic memberGenerateNewId(DateTime) Obsolete.
Generates a new BsonObjectId with a unique value (with the timestamp component based on a given DateTime).
Public methodStatic memberGenerateNewId(Int32) Obsolete.
Generates a new BsonObjectId with a unique value (with the given timestamp).
Public methodGetHashCode
Gets the hash code.
(Overrides BsonValueGetHashCode.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOperatorEqualsImplementation
Implementation of operator ==.
(Inherited from BsonValue.)
Public methodStatic memberParse Obsolete.
Parses a string and creates a new BsonObjectId.
Public methodToBoolean
Converts this BsonValue to a Boolean (using the JavaScript definition of truthiness).
(Inherited from BsonValue.)
Public methodToByteArray Obsolete.
Converts the BsonObjectId to a byte array.
Public methodToDouble
Converts this BsonValue to a Double.
(Inherited from BsonValue.)
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 value.
(Overrides ObjectToString.)
Public methodToUniversalTime
Converts this BsonValue to a DateTime in UTC.
(Inherited from BsonValue.)
Public methodStatic memberTryParse Obsolete.
Tries to parse a string and create a new BsonObjectId.
Public methodWriteTo Obsolete.
Writes the BsonValue to a BsonWriter.
(Inherited from BsonValue.)
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compares two BsonObjectId values.
Public operatorStatic member(ObjectId to BsonObjectId)
Converts an ObjectId to a BsonObjectId.
Public operatorStatic memberInequality
Compares two BsonObjectId values.
Top
Extension Methods

  NameDescription
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 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 propertyCreationTime Obsolete.
Gets the creation time (derived from the timestamp).
Public propertyStatic memberEmpty
Gets an instance of BsonObjectId where the value is empty.
Public propertyIncrement Obsolete.
Gets the increment.
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 (only applies to BsonDocument and BsonArray).
(Inherited from BsonValue.)
Public propertyItemString
Gets or sets a value by name (only applies to BsonDocument).
(Inherited from BsonValue.)
Public propertyMachine Obsolete.
Gets the machine.
Public propertyPid Obsolete.
Gets the PID.
Public propertyRawValue Obsolete.
Gets the BsonObjectId as an ObjectId.
(Overrides BsonValueRawValue.)
Public propertyTimestamp Obsolete.
Gets the timestamp.
Public propertyValue
Gets the value of this BsonObjectId.
Top
See Also

Reference