XmlAttributeOverrides Klasse

Definition

public ref class XmlAttributeOverrides

public class XmlAttributeOverrides

type XmlAttributeOverrides = class

Public Class XmlAttributeOverrides

Vererbung

Object

XmlAttributeOverrides

Beispiele

Im folgenden Beispiel wird eine Klasse mit dem Namen Orchestraserialisiert, die ein einzelnes Feld mit dem Namen Instruments enthält, das ein Array von Instrument Objekten zurückgibt. Eine zweite Klasse mit dem Namen Brass erbt von der Instrument Klasse. Im Beispiel wird eine Instanz der XmlAttributeOverrides Klasse verwendet, um das Instrument Feld außer Kraft zu setzen, sodass das Feld Objekte akzeptieren Brass kann.

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

Hinweise

Dies XmlAttributeOverrides ermöglicht es, die XmlSerializer Standardweise der Serialisierung einer Gruppe von Objekten außer Kraft zu setzen. Das Überschreiben der Serialisierung auf diese Weise hat zwei Verwendungsmöglichkeiten: Erstens können Sie die Serialisierung von Objekten, die in einer DLL gefunden werden, steuern und erweitern, auch wenn Sie keinen Zugriff auf die Quelle haben; Zweitens können Sie einen Satz serialisierbarer Klassen erstellen, aber die Objekte auf mehrere Arten serialisieren. Anstatt beispielsweise Member einer Klasseninstanz als XML-Elemente zu serialisieren, können Sie sie als XML-Attribute serialisieren, was zu einem effizienteren Dokument zum Transport führt.

Nachdem Sie ein XmlAttributeOverrides Objekt erstellt haben, übergeben Sie es als Argument an den XmlSerializer Konstruktor. Im Ergebnis XmlSerializer werden die Daten verwendet, die in den XmlAttributeOverrides Attributen zum Überschreiben enthalten sind, die steuern, wie Objekte serialisiert werden. Dazu enthält die XmlAttributeOverrides Auflistung der Objekttypen, die überschrieben werden, sowie ein XmlAttributes Objekt, das jedem überschriebenen Objekttyp zugeordnet ist. Das XmlAttributes Objekt selbst enthält einen entsprechenden Satz von Attributobjekten, die steuern, wie jedes Feld, jede Eigenschaft oder Klasse serialisiert wird.

Der Prozess zum Erstellen und Verwenden eines XmlAttributeOverrides Objekts lautet wie folgt:

1. Erstellen Sie ein XmlAttributes-Objekt.

2. Erstellen Sie ein Attributobjekt, das für das überschriebene Objekt geeignet ist. Um z. B. ein Feld oder eine Eigenschaft außer Kraft zu setzen, erstellen Sie ein XmlElementAttribute, mit dem neuen abgeleiteten Typ. Sie können optional ein neues ElementNameOder Namespace überschreibt den Attributnamen oder Namespace der Basisklasse.

3. Fügen Sie das Attributobjekt der entsprechenden XmlAttributes Eigenschaft oder Auflistung hinzu. Beispielsweise würden Sie der XmlElements Auflistung des XmlAttributes Objekts die XmlElementAttribute Auflistung hinzufügen und den Elementnamen angeben, der überschrieben wird.

4. Erstellen Sie ein XmlAttributeOverrides-Objekt.

5. Fügen Sie das XmlAttributes Objekt mithilfe der Add Methode dem XmlAttributeOverrides Objekt hinzu. Wenn das überschriebene Objekt ein XmlRootAttribute oder XmlTypeAttributeist, müssen Sie nur den Typ des überschriebenen Objekts angeben. Wenn Sie jedoch ein Feld oder eine Eigenschaft überschreiben, müssen Sie auch den Namen des überschriebenen Elements angeben.

6. Übergeben Sie beim Erstellen des XmlSerializerKonstruktors den XmlAttributeOverridesXmlSerializer Konstruktor.

7. Verwenden Sie die resultierenden XmlSerializer Elemente, um die abgeleiteten Klassenobjekte zu serialisieren oder zu deserialisieren.

Weitere Informationen

• Deserialize(Stream)
• Serialize(TextWriter, Object)
• XmlSerializer
• XmlAttributes
• Einführung in die XML-Serialisierung
• Vorgehensweise: Angeben eines alternativen Elementnamens für einen XML-Stream
• Steuern der XML-Serialisierung mithilfe von Attributen
• Beispiele für die XML-Serialisierung
• XML Schema Definition-Tool (Xsd.exe)