This topic has not yet been rated - Rate this topic

XmlAttributes Constructor

Initializes a new instance of the XmlAttributes class.

Namespace:  System.Xml.Serialization
Assembly:  System.Xml (in System.Xml.dll)
'Declaration
Public Sub New

The following example serializes an instance of a class named Orchestra, which contains a single field named Instruments that returns an array of Instrument objects. A second class named Brass inherits from the Instrument class. The example creates an XmlAttributes object to override the Instrument field--allowing the field to accept Brass objects--and adds the XmlAttributes object to an instance of the XmlAttributeOverrides class.

Imports System
Imports System.IO
Imports System.Xml.Serialization
Imports Microsoft.VisualBasic


Public Class Orchestra
    Public Instruments() As Instrument
End Class 

Public Class Instrument
    Public Name As String 
End Class 

Public Class Brass
    Inherits Instrument
    Public IsValved As Boolean 
End Class 


Public Class Run

    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("Override.xml")
        test.DeserializeObject("Override.xml")
    End Sub     

    Public Sub SerializeObject(ByVal filename As String)
        ' Each overridden field, property, or type requires 
        ' an XmlAttributes object.  
        Dim attrs As New XmlAttributes()

        ' Create an XmlElementAttribute to override the 
        ' field that returns Instrument objects. The overridden field 
        ' returns Brass objects instead.  
        Dim attr As New XmlElementAttribute()
        attr.ElementName = "Brass"
        attr.Type = GetType(Brass)

        ' Add the element to the collection of elements.
        attrs.XmlElements.Add(attr)

        ' Create the XmlAttributeOverrides object. 
        Dim attrOverrides As New XmlAttributeOverrides()

        ' Add the type of the class that contains the overridden 
        ' member and the XmlAttributes to override it with to the 
        ' XmlAttributeOverrides object. 
        attrOverrides.Add(GetType(Orchestra), "Instruments", attrs)

        ' Create the XmlSerializer using the XmlAttributeOverrides. 
        Dim s As New XmlSerializer(GetType(Orchestra), attrOverrides)

        ' Writing the file requires a TextWriter. 
        Dim writer As New StreamWriter(filename)

        ' Create the object that will be serialized. 
        Dim band As New Orchestra()

        ' Create an object of the derived type. 
        Dim i As New Brass()
        i.Name = "Trumpet"
        i.IsValved = True 
        Dim myInstruments() As Instrument = {i}
        band.Instruments = myInstruments

        ' Serialize the object.
        s.Serialize(writer, band)
        writer.Close()
    End Sub 


    Public Sub DeserializeObject(ByVal filename As String)
        Dim attrOverrides As New XmlAttributeOverrides()
        Dim attrs As New XmlAttributes()

        ' Create an XmlElementAttribute to override the Instrument. 
        Dim attr As New XmlElementAttribute()
        attr.ElementName = "Brass"
        attr.Type = GetType(Brass)

        ' Add the element to the collection of elements.
        attrs.XmlElements.Add(attr)

        attrOverrides.Add(GetType(Orchestra), "Instruments", attrs)

        ' Create the XmlSerializer using the XmlAttributeOverrides. 
        Dim s As New XmlSerializer(GetType(Orchestra), attrOverrides)

        Dim fs As New FileStream(filename, FileMode.Open)
        Dim band As Orchestra = CType(s.Deserialize(fs), Orchestra)
        Console.WriteLine("Brass:")

        ' The difference between deserializing the overridden 
        ' XML document and serializing it is this: To read the derived 
        ' object values, you must declare an object of the derived type 
        ' (Brass), and cast the Instrument instance to it.  
        Dim b As Brass
        Dim i As Instrument
        For Each i In  band.Instruments
            b = CType(i, Brass)
            Console.WriteLine(b.Name + ControlChars.Cr + _
                              b.IsValved.ToString())
        Next i
    End Sub 
End Class

.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

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.

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.