Export (0) Print
Expand All

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)

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

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 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
     

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft