DataContractSerializer Constructor (Type, IEnumerable(Type), Int32, Boolean, Boolean, IDataContractSurrogate) (System.Runtime.Serialization)

DataContractSerializer Constructor ...

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

DataContractSerializer Constructor (Type, IEnumerable<(Of <(Type>)>), Int32, Boolean, Boolean, IDataContractSurrogate)

Initializes a new instance of the DataContractSerializer class to serialize or deserialize an object of the specified type. This method also specifies a list of known types that may be present in the object graph, the maximum number of graph items to serialize, parameters to ignore unexpected data, whether to use non-standard XML constructs to preserve object reference data in the graph, and a surrogate for custom serialization.

Namespace: System.Runtime.Serialization
Assembly: System.Runtime.Serialization (in System.Runtime.Serialization.dll)

Syntax

Visual Basic (Declaration)

Public Sub New ( _
    type As Type, _
    knownTypes As IEnumerable(Of Type), _
    maxItemsInObjectGraph As Integer, _
    ignoreExtensionDataObject As Boolean, _
    preserveObjectReferences As Boolean, _
    dataContractSurrogate As IDataContractSurrogate _
)

Visual Basic (Usage)

Dim type As Type
Dim knownTypes As IEnumerable(Of Type)
Dim maxItemsInObjectGraph As Integer
Dim ignoreExtensionDataObject As Boolean
Dim preserveObjectReferences As Boolean
Dim dataContractSurrogate As IDataContractSurrogate

Dim instance As New DataContractSerializer(type, knownTypes, _
    maxItemsInObjectGraph, ignoreExtensionDataObject, _
    preserveObjectReferences, dataContractSurrogate)

public DataContractSerializer(
    Type type,
    IEnumerable<Type> knownTypes,
    int maxItemsInObjectGraph,
    bool ignoreExtensionDataObject,
    bool preserveObjectReferences,
    IDataContractSurrogate dataContractSurrogate
)

Visual C++

public:
DataContractSerializer(
    Type^ type, 
    IEnumerable<Type^>^ knownTypes, 
    int maxItemsInObjectGraph, 
    bool ignoreExtensionDataObject, 
    bool preserveObjectReferences, 
    IDataContractSurrogate^ dataContractSurrogate
)

JScript

public function DataContractSerializer(
    type : Type, 
    knownTypes : IEnumerable<Type>, 
    maxItemsInObjectGraph : int, 
    ignoreExtensionDataObject : boolean, 
    preserveObjectReferences : boolean, 
    dataContractSurrogate : IDataContractSurrogate
)

Parameters

type: Type: System..::.Type
The type of the instances that are serialized or deserialized.

knownTypes: Type: System.Collections.Generic..::.IEnumerable<(Of <(Type>)>)
An IEnumerable<(Of <(T>)>) of Type that contains the known types that may be present in the object graph.

maxItemsInObjectGraph: Type: System..::.Int32
The maximum number of items in the graph to serialize or deserialize. The default is the value returned by the MaxValue property.

ignoreExtensionDataObject: Type: System..::.Boolean
true to ignore the data supplied by an extension of the type upon serialization and deserialization; otherwise, false.

preserveObjectReferences: Type: System..::.Boolean
true to use non-standard XML constructs to preserve object reference data; otherwise, false.

dataContractSurrogate: Type: System.Runtime.Serialization..::.IDataContractSurrogate
An implementation of the IDataContractSurrogate to customize the serialization process.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The number of items exceeds the maximum value.

Examples

The following example creates an instance of the DataContractSerializer that specifies the type to serialize or deserialize and an instance of a IEnumerable<(Of <(T>)>) to contain the known types used during serialization or deserialization. The code also sets the ignoreExtensionDataObject and preserveObjectReferences parameters to true, and specifies an implementation of the IDataContractSurrogate interface to handle legacy types (types that do not have the DataContractAttribute attribute applied). For more information, see the IDataContractSurrogate documentation.

Visual Basic

Public Shared Sub Constructor7() 

    ' Create a generic List of types and add the known types
    ' to the collection.
    Dim knownTypeList As New List(Of Type)
    knownTypeList.Add(GetType(PurchaseOrder))
    knownTypeList.Add(GetType(PurchaseOrderV3))

    ' Create an instance of a class that 
    ' implements the IDataContractSurrogate interface.
    ' The implementation code is not shown here.
    Dim mySurrogate As New DCSurrogate()

    Dim ser As New DataContractSerializer(GetType(Person), _
    knownTypeList, _
    64 * 1064, _
    True, _
    True, _
     mySurrogate)

    ' Other code not shown.
End Sub

public static void Constructor7()
{
    // Create a generic List of types and add the known types
    // to the collection.
    List<Type> knownTypeList = new List<Type>();
    knownTypeList.Add(typeof(PurchaseOrder));
    knownTypeList.Add(typeof(PurchaseOrderV3));

    // Create an instance of a class that 
    // implements the IDataContractSurrogate interface.
    // The implementation code is not shown here.
    DCSurrogate mySurrogate = new DCSurrogate();

    DataContractSerializer ser =
        new DataContractSerializer(
        typeof(Person),
        knownTypeList,
        64 * 1024,
        true,
        true,
        mySurrogate);
    // Other code not shown.
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

DataContractSerializer Class

DataContractSerializer Members

DataContractSerializer Overload

System.Runtime.Serialization Namespace

MaxItemsInObjectGraph

PreserveObjectReferences

IgnoreExtensionDataObject

IExtensibleDataObject

ExtensionDataObject

KnownTypeAttribute

IDataContractSurrogate