Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

DataContractSerializer Constructor (Type, XmlDictionaryString, XmlDictionaryString, IEnumerable<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, a surrogate for custom serialization, and parameters of XmlDictionaryString that specify the XML element and namespace that contain the content.

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

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

Parameters

type
Type: System.Type

The type of the instances that are serialized or deserialized.

rootName
Type: System.Xml.XmlDictionaryString

The XmlDictionaryString that specifies the XML element that encloses the content to serialize or deserialize.

rootNamespace
Type: System.Xml.XmlDictionaryString

The XmlDictionaryString that specifies the XML namespace of the root.

knownTypes
Type: System.Collections.Generic.IEnumerable<Type>

A IEnumerable<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.

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.

Exception Condition
ArgumentOutOfRangeException

The number of items exceeds the maximum value.

The following example creates an instance of the DataContractSerializer that specifies the type to serialize or deserialize, the root XML element and namespace (as XmlDictionaryString parameters), and an instance of a IEnumerable<T> that contains the types used during 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.

public static void Constructor9()
{
    // 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 XmlDictionary and add values to it.
    XmlDictionary d = new XmlDictionary();
    XmlDictionaryString name_value = d.Add("Customer");
    XmlDictionaryString ns_value = d.Add("http://www.contoso.com");

    // 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),
        name_value,
        ns_value,
        knownTypeList,
        64 * 1024,
        true,
        true,
        mySurrogate);

    // Other code not shown.
}

.NET Framework
Available since 3.0
Return to top
Show: