Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

XmlAttributes.XmlArray Property

Gets or sets an object that specifies how the XmlSerializer serializes a public field or read/write property that returns an array.

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

'Declaration
Public Property XmlArray As XmlArrayAttribute
'Usage
Dim instance As XmlAttributes
Dim value As XmlArrayAttribute

value = instance.XmlArray

instance.XmlArray = value
/** @property */
public XmlArrayAttribute get_XmlArray ()

/** @property */
public void set_XmlArray (XmlArrayAttribute value)

public function get XmlArray () : XmlArrayAttribute

public function set XmlArray (value : XmlArrayAttribute)

Property Value

An XmlArrayAttribute that specifies how the XmlSerializer serializes a public field or read/write property that returns an array.

There are two ways in which a public field or public read/write property that returns an array is serialized by the XmlSerializer: the default serialization, and the controlled serialization.

In the default serialization, no attribute is applied to the member. When serialized, the array is serialized as a nested sequence of XML elements with the XML element name of the nested sequence taken from the member name.

To control the serialization more precisely, apply an XmlArrayAttribute to the field or property. For example, you can change the generated XML element name from the default to a different name by setting the ElementName property to a new value.

The XmlArray property allows you to override the default serialization, as well as the serialization controlled by applying an XmlArrayAttribute to the member. For example, you can change the XML element name generated from the default (the member identifier) to a new value. In addition, if you apply an XmlArrayAttribute to a member, it is overridden by any XmlArrayAttribute that is assigned to the XmlArray property.

The following example serializes a class that contains a field named Members that returns an array of objects. The XmlArrayAttribute is used to override the serialization of the field, and rename the element name to Staff.

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


' This is the class that will be serialized.
Public Class Group
    ' This field will be overridden.
    Public Members() As Member
End Class

Public Class Member
    Public MemberName As String
End Class

Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("OverrideArray.xml")
        test.DeserializeObject("OverrideArray.xml")
    End Sub
    
    ' Return an XmlSerializer used for overriding. 
    Public Function CreateOverrider() As XmlSerializer
        ' Creating XmlAttributeOverrides and XmlAttributes objects.
        Dim xOver As New XmlAttributeOverrides()
        Dim xAttrs As New XmlAttributes()
        
        ' Add an override for the XmlArray.    
        Dim xArray As New XmlArrayAttribute("Staff")
        xArray.Namespace = "http://www.cpandl.com"
        xAttrs.XmlArray = xArray
        xOver.Add(GetType(Group), "Members", xAttrs)
        
        ' Create the XmlSerializer and return it.
        Return New XmlSerializer(GetType(Group), xOver)
    End Function
    
    Public Sub SerializeObject(ByVal filename As String)
        ' Create an instance of the XmlSerializer class.
        Dim mySerializer As XmlSerializer = CreateOverrider()
        ' Writing the file requires a TextWriter.
        Dim writer As New StreamWriter(filename)
        
        ' Create an instance of the class that will be serialized.
        Dim myGroup As New Group()
        
        ' Set the object properties.
        Dim m As New Member()
        m.MemberName = "Paul"
        myGroup.Members = New Member(0) {m}
        
        ' Serialize the class, and close the TextWriter.
        mySerializer.Serialize(writer, myGroup)
        writer.Close()
    End Sub    
    
    Public Sub DeserializeObject(ByVal filename As String)
        Dim mySerializer As XmlSerializer = CreateOverrider()
        Dim fs As New FileStream(filename, FileMode.Open)
        Dim myGroup As Group = CType(mySerializer.Deserialize(fs), Group)
        Dim m As Member
        For Each m In  myGroup.Members
            Console.WriteLine(m.MemberName)
        Next m
    End Sub
End Class


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

// This is the class that will be serialized.
public class Group
{
    // This field will be overridden.
    public Member members[];
} //Group

public class Member
{
    public String memberName;
} //Member

public class Run
{
    public static void main(String[] args)
    {
        Run test = new Run();
        test.SerializeObject("OverrideArray.xml");
        test.DeserializeObject("OverrideArray.xml");
    } //main

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

        // Add an override for the XmlArray.    
        XmlArrayAttribute xArray = new XmlArrayAttribute("Staff");
        xArray.set_Namespace("http://www.cpandl.com");
        xAttrs.set_XmlArray(xArray);
        xOver.Add(Group.class.ToType(), "Members", xAttrs);

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

    public void SerializeObject(String fileName)
    {
        // Create an instance of the XmlSerializer class.
        XmlSerializer mySerializer = CreateOverrider();

        // Writing the file requires a TextWriter.
        TextWriter writer = new StreamWriter(fileName);

        // Create an instance of the class that will be serialized.
        Group myGroup = new Group();

        // Set the object properties.
        Member m = new Member();
        m.memberName = "Paul";
        myGroup.members = new Member[] { m };

        // Serialize the class, and close the TextWriter.
        mySerializer.Serialize(writer, myGroup);
        writer.Close();
    } //SerializeObject

    public void DeserializeObject(String fileName)
    {
        XmlSerializer mySerializer = CreateOverrider();
        FileStream fs = new FileStream(fileName, FileMode.Open);
        Group myGroup = (Group)mySerializer.Deserialize(fs);
        for (int iCtr = 0; iCtr < myGroup.members.length; iCtr++) {
            Member m = myGroup.members[iCtr];
            Console.WriteLine(m.memberName);
        }
    } //DeserializeObject
} //Run

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.