XmlAttributes.XmlArray Properti

Definisi

Ruang nama:

System.Xml.Serialization

Rakitan:

netstandard.dll, System.Xml.XmlSerializer.dll

Sumber:

XmlAttributes.cs

Mendapatkan atau mengatur objek yang menentukan bagaimana XmlSerializer menserialisasikan bidang publik atau properti baca/tulis yang mengembalikan array.

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

Nilai Properti

XmlArrayAttribute

Yang XmlArrayAttribute menentukan bagaimana XmlSerializer menserialisasikan bidang publik atau properti baca/tulis yang mengembalikan array.

Contoh

Contoh berikut menserialisasikan kelas yang berisi bidang bernama Members yang mengembalikan array objek. XmlArrayAttribute digunakan untuk mengambil alih serialisasi bidang, dan mengganti nama elemen menjadi 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

Keterangan

Ada dua cara di mana bidang publik atau properti baca/tulis publik yang mengembalikan array diserialisasikan oleh XmlSerializer: serialisasi default, dan serialisasi terkontrol.

Dalam serialisasi default, tidak ada atribut yang diterapkan ke anggota. Saat diserialisasikan, array diserialisasikan sebagai urutan berlapis elemen XML dengan nama elemen XML dari urutan berlapis yang diambil dari nama anggota.

Untuk mengontrol serialisasi dengan lebih tepat, terapkan XmlArrayAttribute ke bidang atau properti. Misalnya, Anda dapat mengubah nama elemen XML yang dihasilkan dari default ke nama yang berbeda dengan mengatur ElementName properti ke nilai baru.

Properti XmlArray memungkinkan Anda untuk mengambil alih serialisasi default, serta serialisasi yang dikendalikan dengan menerapkan XmlArrayAttribute ke anggota. Misalnya, Anda dapat mengubah nama elemen XML yang dihasilkan dari default (pengidentifikasi anggota) menjadi nilai baru. Selain itu, jika Anda menerapkan XmlArrayAttribute ke anggota, itu ditimpa oleh apa pun XmlArrayAttribute yang ditetapkan ke XmlArray properti.