DictionarySerializerBase(TDictionary, TKey, TValue) Class

MongoDB .NET Driver API Documentation

MongoDB .NET Driver API Documentation

MongoDB.Bson.Serialization.Serializers

DictionarySerializerBase(TDictionary, TKey, TValue) Class

DictionarySerializerBase(TDictionary, TKey, TValue) Constructor

DictionarySerializerBase(TDictionary, TKey, TValue) Methods

DictionarySerializerBase(TDictionary, TKey, TValue) Properties

Click or drag to resize

DictionarySerializerBaseTDictionary, TKey, TValue Class

Represents a serializer for dictionaries.

Inheritance Hierarchy

SystemObject
  MongoDB.Bson.Serialization.SerializersSerializerBaseTDictionary
    MongoDB.Bson.Serialization.SerializersClassSerializerBaseTDictionary
      MongoDB.Bson.Serialization.SerializersDictionarySerializerBaseTDictionary, TKey, TValue
        MongoDB.Bson.Serialization.SerializersDictionaryInterfaceImplementerSerializerTDictionary, TKey, TValue

Namespace: MongoDB.Bson.Serialization.Serializers
Assembly: MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.1.0

Syntax

public abstract class DictionarySerializerBase<TDictionary, TKey, TValue> : ClassSerializerBase<TDictionary>, 
	IBsonDocumentSerializer, IBsonSerializer, IBsonDictionarySerializer
where TDictionary : class, Object, IDictionary<TKey, TValue>

Public MustInherit Class DictionarySerializerBase(Of TDictionary As {Class, Object, IDictionary(Of TKey, TValue)}, TKey, TValue)
	Inherits ClassSerializerBase(Of TDictionary)
	Implements IBsonDocumentSerializer, IBsonSerializer, IBsonDictionarySerializer

[<AbstractClassAttribute>]
type DictionarySerializerBase<'TDictionary, 'TKey, 'TValue when 'TDictionary : not struct and Object and IDictionary<'TKey, 'TValue>> =  
    class
        inherit ClassSerializerBase<'TDictionary>
        interface IBsonDocumentSerializer
        interface IBsonSerializer
        interface IBsonDictionarySerializer
    end

Type Parameters

TDictionary: The type of the dictionary.
TKey: The type of the keys.
TValue: The type of the values.

The DictionarySerializerBaseTDictionary, TKey, TValue type exposes the following members.

Constructors

	Name	Description
	DictionarySerializerBaseTDictionary, TKey, TValue	Initializes a new instance of the DictionarySerializerBaseTDictionary, TKey, TValue class.
	DictionarySerializerBaseTDictionary, TKey, TValue(DictionaryRepresentation)	Initializes a new instance of the DictionarySerializerBaseTDictionary, TKey, TValue class.
	DictionarySerializerBaseTDictionary, TKey, TValue(DictionaryRepresentation, IBsonSerializerRegistry)	Initializes a new instance of the DictionarySerializerBaseTDictionary, TKey, TValue class.
	DictionarySerializerBaseTDictionary, TKey, TValue(DictionaryRepresentation, IBsonSerializerTKey, IBsonSerializerTValue)	Initializes a new instance of the DictionarySerializerBaseTDictionary, TKey, TValue class.

Methods

	Name	Description
	CreateCannotBeDeserializedException	Creates an exception to throw when a type cannot be deserialized. (Inherited from SerializerBaseTValue.)
	CreateCannotBeSerializedException	Creates an exception to throw when a type cannot be deserialized. (Inherited from SerializerBaseTValue.)
	CreateCannotDeserializeFromBsonTypeException	Creates an exception to throw when a type cannot be deserialized from a BsonType. (Inherited from SerializerBaseTValue.)
	CreateInstance	Creates the instance.
	Deserialize	Deserializes a value. (Inherited from ClassSerializerBaseTValue.)
	DeserializeValue	Deserializes a value. (Overrides ClassSerializerBaseTValueDeserializeValue(BsonDeserializationContext, BsonDeserializationArgs).)
	EnsureBsonTypeEquals	Ensures that the BsonType equals the expected type. (Inherited from SerializerBaseTValue.)
	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.)
	GetActualType	Gets the actual type. (Inherited from ClassSerializerBaseTValue.)
	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.)
	Serialize	Serializes a value. (Inherited from ClassSerializerBaseTValue.)
	SerializeValue	Serializes a value. (Overrides ClassSerializerBaseTValueSerializeValue(BsonSerializationContext, BsonSerializationArgs, TValue).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetMemberSerializationInfo	Tries to get the serialization info for a member.

Extension Methods

	Name	Description
	Deserialize	Deserializes a value. (Defined by IBsonSerializerExtensions.)
	Serialize	Serializes a value. (Defined by IBsonSerializerExtensions.)
	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.)

Properties

	Name	Description
	DictionaryRepresentation	Gets the dictionary representation.
	KeySerializer	Gets the key serializer.
	ValueSerializer	Gets the value serializer.
	ValueType	Gets the type of the values. (Inherited from SerializerBaseTValue.)

See Also

Reference

MongoDB.Bson.Serialization.Serializers Namespace

Copyright © 2010-2015 MongoDB Inc.

Send comments on this topic to MongoDB