Export (0) Print
Expand All
1 out of 1 rated this helpful - Rate this topic

XmlAttributes.XmlElements Property

Gets a collection of objects that specify how the XmlSerializer serializes a public field or read/write property as an XML element.

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

'Declaration
Public ReadOnly Property XmlElements As XmlElementAttributes
'Usage
Dim instance As XmlAttributes
Dim value As XmlElementAttributes

value = instance.XmlElements

/** @property */
public XmlElementAttributes get_XmlElements ()

public function get XmlElements () : XmlElementAttributes

Property Value

An XmlElementAttributes that contains a collection of XmlElementAttribute objects.

For each overridden member that is serialized as an XML element, you must add a new XmlElementAttribute to an XmlElementAttributes by calling the Add method. By default, an XmlElementAttributes object is created and assigned to the XmlElements property.

The following example serializes the Transportation class, which contains a single field named Vehicles that returns an ArrayList. The example applies two XmlElementAttribute attributes to the Vehicles field. The example creates two XmlElementAttribute objects and adds them to the XmlElementAttributes collection of an XmlAttributes object. To allow the array to accept different object types, the XmlAttributes object is added to the XmlAttributeOverrides object.

Imports System
Imports System.IO
Imports System.Xml.Serialization
Imports System.Collections
Imports System.Xml


Public Class Transportation
    ' Subsequent code overrides these two XmlElementAttributes.
    <XmlElement(GetType(Car)), _
     XmlElement(GetType(Plane))> _
    Public Vehicles As ArrayList
End Class

Public Class Car
    Public Name As String
End Class

Public Class Plane
    Public Name As String
End Class

Public Class Truck
    Public Name As String
End Class

Public Class Train
    Public Name As String
End Class


Public Class Test
    
    Public Shared Sub Main()
        Dim t As New Test()
        t.SerializeObject("OverrideElement.xml")
    End Sub
    
    
    ' Return an XmlSerializer used for overriding.
    Public Function CreateOverrider() As XmlSerializer
        ' Create the XmlAttributes and XmlAttributeOverrides objects.
        Dim attrs As New XmlAttributes()
        
        Dim xOver As New XmlAttributeOverrides()
        
        
        ' Create an XmlElementAttribute to override
        ' the Vehicles property. 
        Dim xElement1 As New XmlElementAttribute(GetType(Truck))
        ' Add the XmlElementAttribute to the collection.
        attrs.XmlElements.Add(xElement1)
        
        ' Create a second XmlElementAttribute, and
        ' add it to the collection. 
        Dim xElement2 As New XmlElementAttribute(GetType(Train))
        attrs.XmlElements.Add(xElement2)
        
        ' Add the XmlAttributes to the XmlAttributeOverrides,
        ' specifying the member to override. 
        xOver.Add(GetType(Transportation), "Vehicles", attrs)
        
        ' Create the XmlSerializer, and return it.
        Dim xSer As New XmlSerializer(GetType(Transportation), xOver)
        Return xSer
    End Function
    
    
    Public Sub SerializeObject(ByVal filename As String)
        ' Create an XmlSerializer instance.
        Dim xSer As XmlSerializer = CreateOverrider()
        
        ' Create the object and serialize it.
        Dim myTransportation As New Transportation()
        
        ' Create two new override objects that can be
'
        ' inserted into the array. 
        myTransportation.Vehicles = New ArrayList()
        Dim myTruck As New Truck()
        myTruck.Name = "MyTruck"
        
        Dim myTrain As New Train()
        myTrain.Name = "MyTrain"
        
        myTransportation.Vehicles.Add(myTruck)
        myTransportation.Vehicles.Add(myTrain)
        
        Dim writer As New StreamWriter(filename)
        xSer.Serialize(writer, myTransportation)
    End Sub
End Class


import System.*;
import System.IO.*;
import System.Xml.Serialization.*;
import System.Collections.*;
import System.Xml.*;

public class Transportation
{
    // Subsequent code overrides these two XmlElementAttributes.
    /** @attribute XmlElement(Car.class)
        @attribute XmlElement(Plane.class)
     */
    public ArrayList vehicles;
} //Transportation

public class Car
{
    public String name;
} //Car

public class Plane
{
    public String name;
} //Plane

public class Truck
{
    public String name;
} //Truck

public class Train
{
    public String name;
} //Train

public class Test
{
    public static void main(String[] args)
    {
        Test t = new Test();
        t.SerializeObject("OverrideElement.xml");
    } //main

    // Return an XmlSerializer used for overriding.
    public XmlSerializer CreateOverrider()
    {
        // Create the XmlAttributes and XmlAttributeOverrides objects.
        XmlAttributes attrs = new XmlAttributes();
        XmlAttributeOverrides xOver = new XmlAttributeOverrides();

        /* Create an XmlElementAttribute to override 
           the Vehicles property. */
        XmlElementAttribute xElement1 =
            new XmlElementAttribute(Truck.class.ToType());

        // Add the XmlElementAttribute to the collection.
        attrs.get_XmlElements().Add(xElement1);

        /* Create a second XmlElementAttribute, and 
           add it to the collection. */
        XmlElementAttribute xElement2 =
            new XmlElementAttribute(Train.class.ToType());
        attrs.get_XmlElements().Add(xElement2);

        /* Add the XmlAttributes to the XmlAttributeOverrides,
           specifying the member to override. */
        xOver.Add(Transportation.class.ToType(), "vehicles", attrs);

        // Create the XmlSerializer, and return it.
        XmlSerializer xSer =
            new XmlSerializer(Transportation.class.ToType(), xOver);
        return xSer;
    } //CreateOverrider

    public void SerializeObject(String fileName)
    {
        // Create an XmlSerializer instance.
        XmlSerializer xSer = CreateOverrider();

        // Create the object and serialize it.
        Transportation myTransportation = new Transportation();

        /* Create two new override objects that can be
           inserted into the array. */
        myTransportation.vehicles = new ArrayList();
        Truck myTruck = new Truck();
        myTruck.name = "MyTruck";

        Train myTrain = new Train();
        myTrain.name = "MyTrain";

        myTransportation.vehicles.Add(myTruck);
        myTransportation.vehicles.Add(myTrain);
        TextWriter writer = new StreamWriter(fileName);
        xSer.Serialize(writer, myTransportation);
    } //SerializeObject
} //Test

Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.