XmlAttributeOverrides Kelas

Definisi

Ruang nama:

System.Xml.Serialization

Rakitan:

netstandard.dll, System.Xml.XmlSerializer.dll

Sumber:

XmlAttributeOverrides.cs

Memungkinkan Anda mengambil alih atribut properti, bidang, dan kelas saat Anda menggunakan XmlSerializer untuk menserialisasikan atau mendeserialisasi objek.

public ref class XmlAttributeOverrides

public class XmlAttributeOverrides

type XmlAttributeOverrides = class

Public Class XmlAttributeOverrides

Warisan

Object

XmlAttributeOverrides

Contoh

Contoh berikut menserialisasikan kelas bernama Orchestra, yang berisi satu bidang bernama Instruments yang mengembalikan array Instrument objek. Kelas kedua bernama Brass mewarisi dari Instrument kelas . Contoh menggunakan instans XmlAttributeOverrides kelas untuk mengambil Instrument alih bidang, memungkinkan bidang menerima Brass objek.

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

public class Orchestra
{
   public Instrument[] Instruments;
}

public class Instrument
{
   public string Name;
}

public class Brass:Instrument
{
   public bool IsValved;
}

public class Run
{
    public static void Main()
    {
       Run test = new Run();
       test.SerializeObject("Override.xml");
       test.DeserializeObject("Override.xml");
    }

    public void SerializeObject(string filename)
    {
      /* Each overridden field, property, or type requires
      an XmlAttributes object. */
      XmlAttributes attrs = new XmlAttributes();

      /* Create an XmlElementAttribute to override the
      field that returns Instrument objects. The overridden field
      returns Brass objects instead. */
      XmlElementAttribute attr = new XmlElementAttribute();
      attr.ElementName = "Brass";
      attr.Type = typeof(Brass);

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

      // Create the XmlAttributeOverrides object.
      XmlAttributeOverrides attrOverrides = 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(typeof(Orchestra), "Instruments", attrs);

      // Create the XmlSerializer using the XmlAttributeOverrides.
      XmlSerializer s =
      new XmlSerializer(typeof(Orchestra), attrOverrides);

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

      // Create the object that will be serialized.
      Orchestra band = new Orchestra();

      // Create an object of the derived type.
      Brass i = new Brass();
      i.Name = "Trumpet";
      i.IsValved = true;
      Instrument[] myInstruments = {i};
      band.Instruments = myInstruments;

      // Serialize the object.
      s.Serialize(writer,band);
      writer.Close();
   }

   public void DeserializeObject(string filename)
   {
      XmlAttributeOverrides attrOverrides =
         new XmlAttributeOverrides();
      XmlAttributes attrs = new XmlAttributes();

      // Create an XmlElementAttribute to override the Instrument.
      XmlElementAttribute attr = new XmlElementAttribute();
      attr.ElementName = "Brass";
      attr.Type = typeof(Brass);

      // Add the XmlElementAttribute to the collection of objects.
      attrs.XmlElements.Add(attr);

      attrOverrides.Add(typeof(Orchestra), "Instruments", attrs);

      // Create the XmlSerializer using the XmlAttributeOverrides.
      XmlSerializer s =
      new XmlSerializer(typeof(Orchestra), attrOverrides);

      FileStream fs = new FileStream(filename, FileMode.Open);
      Orchestra band = (Orchestra) s.Deserialize(fs);
      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. */
      Brass b;
      foreach(Instrument i in band.Instruments)
      {
         b = (Brass)i;
         Console.WriteLine(
         b.Name + "\n" +
         b.IsValved);
      }
   }
}

Option Explicit
Option Strict

Imports System.IO
Imports System.Xml.Serialization

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(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 XmlElementAttribute to the collection of objects.
        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)
        Next i
    End Sub
End Class

Keterangan

memungkinkan XmlAttributeOverridesXmlSerializer untuk mengambil alih cara default untuk membuat serialisasi sekumpulan objek. Mengambil alih serialisasi dengan cara ini memiliki dua kegunaan: pertama, Anda dapat mengontrol dan menambah serialisasi objek yang ditemukan di DLL--bahkan jika Anda tidak memiliki akses ke sumber; kedua, Anda dapat membuat satu set kelas yang dapat diserialisasikan, tetapi menserialisasikan objek dengan berbagai cara. Misalnya, alih-alih membuat serialisasi anggota instans kelas sebagai elemen XML, Anda dapat menserialisasikannya sebagai atribut XML, menghasilkan dokumen yang lebih efisien untuk diangkut.

Setelah membuat XmlAttributeOverrides objek, Anda meneruskannya sebagai argumen ke XmlSerializer konstruktor. Hasilnya XmlSerializer menggunakan data yang dimuat oleh XmlAttributeOverrides untuk mengambil alih atribut yang mengontrol bagaimana objek diserialisasikan. Untuk mencapai hal ini, XmlAttributeOverrides berisi kumpulan jenis objek yang ditimpa, serta objek yang terkait dengan setiap jenis objek yang XmlAttributes ditimpa. Objek itu XmlAttributes sendiri berisi sekumpulan objek atribut yang sesuai yang mengontrol bagaimana setiap bidang, properti, atau kelas diserialisasikan.

Proses untuk membuat dan menggunakan XmlAttributeOverrides objek adalah sebagai berikut:

1. Membuat objek XmlAttributes.

2. Buat objek atribut yang sesuai dengan objek yang sedang ditimpa. Misalnya, untuk mengambil alih bidang atau properti, buat XmlElementAttribute, menggunakan jenis baru yang diturunkan. Anda dapat secara opsional menetapkan baru ElementName, atau Namespace yang mengambil alih nama atribut atau namespace kelas dasar.

3. Tambahkan objek atribut ke properti atau koleksi yang sesuai XmlAttributes . Misalnya, Anda akan menambahkan XmlElementAttribute ke XmlElements kumpulan XmlAttributes objek, menentukan nama anggota yang sedang ditimpa.

4. Membuat objek XmlAttributeOverrides.

5. Dengan menggunakan metode , Add tambahkan XmlAttributes objek ke XmlAttributeOverrides objek . Jika objek yang ditimpa adalah XmlRootAttribute atau XmlTypeAttribute, Anda hanya perlu menentukan jenis objek yang ditimpa. Tetapi jika Anda mengambil alih bidang atau properti, Anda juga harus menentukan nama anggota yang ditimpa.

6. Saat membuat XmlSerializer, teruskan XmlAttributeOverrides ke XmlSerializer konstruktor.

7. Gunakan yang dihasilkan untuk menserialisasikan XmlSerializer atau mendeserialisasi objek kelas turunan.

Konstruktor

Nama	Deskripsi
XmlAttributeOverrides()	Menginisialisasi instans baru dari kelas XmlAttributeOverrides.

Properti

Nama	Deskripsi
Item[Type, String]	Mendapatkan objek yang terkait dengan jenis (kelas dasar) yang ditentukan. Parameter anggota menentukan anggota kelas dasar yang ditimpa.
Item[Type]	Mendapatkan objek yang terkait dengan jenis, kelas dasar yang ditentukan.

Metode

Nama	Deskripsi
Add(Type, String, XmlAttributes)	XmlAttributes Menambahkan objek ke kumpulan XmlAttributes objek. Parameter type menentukan objek yang akan ditimpa. Parameter member menentukan nama anggota yang ditimpa.
Add(Type, XmlAttributes)	XmlAttributes Menambahkan objek ke kumpulan XmlAttributes objek. Parameter type menentukan objek yang akan ditimpa oleh XmlAttributes objek.
Equals(Object)	Menentukan apakah objek yang ditentukan sama dengan objek saat ini. (Diperoleh dari Object)
GetHashCode()	Berfungsi sebagai fungsi hash default. (Diperoleh dari Object)
GetType()	Mendapatkan Type instans saat ini. (Diperoleh dari Object)
MemberwiseClone()	Membuat salinan dangkal dari Objectsaat ini. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)

Lihat juga

• Deserialize(Stream)
• Serialize(TextWriter, Object)
• XmlSerializer
• XmlAttributes
• Memperkenalkan Serialisasi XML
• Cara: Menentukan Nama Elemen Alternatif untuk Aliran XML
• Mengontrol Serialisasi XML Menggunakan Atribut
• Contoh Serialisasi XML
• Alat Definisi Skema XML (Xsd.exe)