BsonDocumentWriterSettings Class |
Represents settings for a BsonDocumentWriter.
Inheritance HierarchyNamespace: MongoDB.Bson.IO
Assembly: MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.14.0+2b37a1fe1cbdbe1a020b52b77f1197b6d77575e7
SyntaxThe BsonDocumentWriterSettings type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BsonDocumentWriterSettings |
Initializes a new instance of the BsonDocumentWriterSettings class.
|
| BsonDocumentWriterSettings(GuidRepresentation) | Obsolete.
Initializes a new instance of the BsonDocumentWriterSettings class.
|
Properties| Name | Description | |
|---|---|---|
  | Defaults |
Gets or sets the default BsonDocumentWriter settings.
|
| GuidRepresentation | Obsolete.
Gets or sets the representation for Guids.
(Inherited from BsonWriterSettings.) |
| IsFrozen |
Gets whether the settings are frozen.
(Inherited from BsonWriterSettings.) |
| MaxSerializationDepth |
Gets or sets the max serialization depth allowed (used to detect circular references).
(Inherited from BsonWriterSettings.) |
Methods| Name | Description | |
|---|---|---|
| Clone |
Creates a clone of the settings.
|
 | CloneImplementation |
Creates a clone of the settings.
(Overrides BsonWriterSettingsCloneImplementation.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from 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.) |
| Freeze |
Freezes the settings.
(Inherited from BsonWriterSettings.) |
| FrozenCopy |
Returns a frozen copy of the settings.
(Inherited from BsonWriterSettings.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ThrowFrozenException |
Throws an InvalidOperationException when an attempt is made to change a setting after the settings are frozen.
(Inherited from BsonWriterSettings.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
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