Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

XmlSerializer.XmlSerializer(Type, XmlRootAttribute) Constructor

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)

'Declaration
Public Sub New ( _
	type As Type, _
	root As XmlRootAttribute _
)
'Usage
Dim type As Type
Dim root As XmlRootAttribute

Dim instance As New XmlSerializer(type, root)
public XmlSerializer (
	Type type, 
	XmlRootAttribute root
)
public function XmlSerializer (
	type : Type, 
	root : XmlRootAttribute
)
Not applicable.

Parameters

type

The type of the object that this XmlSerializer can serialize.

root

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 Sub SerializeObject(ByVal filename As String)
    ' Create an XmlRootAttribute, and set its properties.
    Dim xRoot As New XmlRootAttribute()
    xRoot.ElementName = "CustomRoot"
    xRoot.Namespace = "http://www.cpandl.com"
    xRoot.IsNullable = True
    
    ' Construct the XmlSerializer with the XmlRootAttribute.
    Dim serializer As New XmlSerializer(GetType(OrderedItem), xRoot)
    
    ' Create an instance of the object to serialize.
    Dim i As New OrderedItem()
    ' Insert code to set properties of the ordered item.
    ' Writing the document requires a TextWriter.
    Dim writer As New StreamWriter(filename)
    
    serializer.Serialize(writer, i)
    writer.Close()
End Sub
    
Private Sub DeserializeObject(ByVal filename As String)
    ' Create an XmlRootAttribute, and set its properties.
    Dim xRoot As New XmlRootAttribute()
    xRoot.ElementName = "CustomRoot"
    xRoot.Namespace = "http://www.cpandl.com"
    xRoot.IsNullable = True
    
    Dim serializer As New XmlSerializer(GetType(OrderedItem), xRoot)
    
    ' A FileStream is needed to read the XML document.
    Dim fs As New FileStream(filename, FileMode.Open)
    ' Deserialize the object.
    Dim i As OrderedItem = CType(serializer.Deserialize(fs), OrderedItem)
    ' Insert code to use the object's properties and methods.
End Sub
     

private void SerializeObject(String filename)
{
    // Create an XmlRootAttribute, and set its properties.
    XmlRootAttribute xRoot = new XmlRootAttribute();
    xRoot.set_ElementName("CustomRoot");
    xRoot.set_Namespace("http://www.cpandl.com");
    xRoot.set_IsNullable(true);

    // Construct the XmlSerializer with the XmlRootAttribute.
    XmlSerializer serializer =
        new XmlSerializer(OrderedItem.class.ToType(), 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();
} //SerializeObject

private void DeserializeObject(String filename)
{
    // Create an XmlRootAttribute, and set its properties.
    XmlRootAttribute xRoot = new XmlRootAttribute();
    xRoot.set_ElementName("CustomRoot");
    xRoot.set_Namespace("http://www.cpandl.com");
    xRoot.set_IsNullable(true);

    XmlSerializer serializer =
        new XmlSerializer(OrderedItem.class.ToType(), 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.
} //DeserializeObject

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2015 Microsoft