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.

XmlSerializer Constructor (Type, XmlRootAttribute)

Initializes a new instance of the XmlSerializer class that can serialize objects of the specified type into XML documents, and deserialize an XML document into object of the specified type. It also specifies the class to use as the XML root element.

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

public XmlSerializer(
	Type type,
	XmlRootAttribute root
)

Parameters

type
Type: System.Type

The type of the object that this XmlSerializer can serialize.

root
Type: System.Xml.Serialization.XmlRootAttribute

An XmlRootAttribute that represents the XML root element.

The root element of an XML document encloses all the other elements. By default, the object specified by the type parameter is serialized as the root element. Properties, such as the XML element name of the root element, are taken from the type object. However, the root parameter allows you to replace the default object's information by specifying an XmlRootAttribute; the object allows you to set a different namespace, element name, and so on.

The following example constructs an XmlSerializer that uses an XmlRootAttribute that contains various properties of the XML root element, such as its namespace and element name.

private void SerializeObject(string filename) {
    // Create an XmlRootAttribute, and set its properties.
    XmlRootAttribute xRoot = new XmlRootAttribute();
    xRoot.ElementName = "CustomRoot";
    xRoot.Namespace = "http://www.cpandl.com";
    xRoot.IsNullable = true;

    // Construct the XmlSerializer with the XmlRootAttribute.
    XmlSerializer serializer = new XmlSerializer
        (typeof(OrderedItem),xRoot);

    // Create an instance of the object to serialize.
    OrderedItem i = new OrderedItem();
    // Insert code to set properties of the ordered item. 

    // Writing the document requires a TextWriter.
    TextWriter writer = new StreamWriter(filename);

    serializer.Serialize(writer, i);
    writer.Close();
}

private void DeserializeObject(string filename) {
    // Create an XmlRootAttribute, and set its properties.
    XmlRootAttribute xRoot = new XmlRootAttribute();
    xRoot.ElementName = "CustomRoot";
    xRoot.Namespace = "http://www.cpandl.com";
    xRoot.IsNullable = true;

    XmlSerializer serializer = new XmlSerializer
        (typeof(OrderedItem),xRoot);

    // A FileStream is needed to read the XML document.
    FileStream fs = new FileStream(filename, FileMode.Open);
    // Deserialize the object.
    OrderedItem i = (OrderedItem) serializer.Deserialize(fs);
    // Insert code to use the object's properties and methods.
}
private:
    void SerializeObject(String* filename) {
        // Create an XmlRootAttribute, and set its properties.
        XmlRootAttribute* xRoot = new XmlRootAttribute();
        xRoot->ElementName = S"CustomRoot";
        xRoot->Namespace = S"http://www.cpandl.com";
        xRoot->IsNullable = true;

        // Construct the XmlSerializer with the XmlRootAttribute.
        XmlSerializer* serializer = new XmlSerializer
            (__typeof(OrderedItem),xRoot);

        // Create an instance of the object to serialize.
        OrderedItem* i = new OrderedItem();
        // Insert code to set properties of the ordered item.

        // Writing the document requires a TextWriter.
        TextWriter* writer = new StreamWriter(filename);

        serializer->Serialize(writer, i);
        writer->Close();
    }

private:
    void DeserializeObject(String* filename) {
        // Create an XmlRootAttribute, and set its properties.
        XmlRootAttribute* xRoot = new XmlRootAttribute();
        xRoot->ElementName = S"CustomRoot";
        xRoot->Namespace = S"http://www.cpandl.com";
        xRoot->IsNullable = true;

        XmlSerializer* serializer = new XmlSerializer
            (__typeof(OrderedItem),xRoot);

        // A FileStream is needed to read the XML document.
        FileStream* fs = new FileStream(filename, FileMode::Open);
        // Deserialize the object.
        OrderedItem* i = dynamic_cast<OrderedItem*> (serializer->Deserialize(fs));
        // Insert code to use the object's properties and methods.
    }

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

Show:
© 2014 Microsoft