XmlAttributes.XmlArray Свойство

Определение

Пространство имен:

System.Xml.Serialization

Сборки:

netstandard.dll, System.Xml.XmlSerializer.dll

Исходный код:

XmlAttributes.cs

Возвращает или задает объект, указывающий, как XmlSerializer сериализует общедоступное поле или свойство чтения или записи, возвращающее массив.

public:
 property System::Xml::Serialization::XmlArrayAttribute ^ XmlArray { System::Xml::Serialization::XmlArrayAttribute ^ get(); void set(System::Xml::Serialization::XmlArrayAttribute ^ value); };

public System.Xml.Serialization.XmlArrayAttribute? XmlArray { get; set; }

member this.XmlArray : System.Xml.Serialization.XmlArrayAttribute with get, set

Public Property XmlArray As XmlArrayAttribute

Значение свойства

XmlArrayAttribute

Значение, XmlArrayAttribute указывающее, как XmlSerializer сериализует общедоступное поле или свойство чтения или записи, возвращающее массив.

Примеры

В следующем примере сериализуется класс, содержащий поле с именем Members поля, которое возвращает массив объектов. Используется XmlArrayAttribute для переопределения сериализации поля и переименования имени элемента Staffв .

using System;
using System.IO;
using System.Xml;
using System.Xml.Serialization;

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

public class Member
{
   public string MemberName;
}

public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeObject("OverrideArray.xml");
      test.DeserializeObject("OverrideArray.xml");
   }
   // 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.Namespace = "http://www.cpandl.com";
      xAttrs.XmlArray = xArray;
      xOver.Add(typeof(Group), "Members", xAttrs);

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

   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[1] {m};

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

   public void DeserializeObject(string filename)
   {
      XmlSerializer mySerializer = CreateOverrider();
      FileStream fs = new FileStream(filename, FileMode.Open);
      Group myGroup = (Group)
      mySerializer.Deserialize(fs);
      foreach(Member m in myGroup.Members)
      {
         Console.WriteLine(m.MemberName);
      }
   }
}

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

Комментарии

Существует два способа, в которых открытое поле или общедоступное свойство чтения и записи, возвращающее массив, сериализуется с помощью XmlSerializer: сериализации по умолчанию и управляемой сериализации.

В сериализации по умолчанию атрибут не применяется к члену. При сериализации массив сериализуется в виде вложенной последовательности XML-элементов с именем XML-элемента вложенной последовательности, взятой из имени члена.

Чтобы точнее управлять сериализацией, примените его XmlArrayAttribute к полю или свойству. Например, можно изменить созданное имя XML-элемента с имени по умолчанию на другое имя, задав ElementName свойству новое значение.

Свойство XmlArray позволяет переопределить сериализацию по умолчанию, а также сериализацию, контролируемую применением XmlArrayAttribute к члену. Например, можно изменить имя XML-элемента, созданное по умолчанию (идентификатор члена) на новое значение. Кроме того, если вы применяете к члену XmlArrayAttribute , оно переопределяется любым XmlArrayAttribute , назначенным свойству XmlArray .