XmlAttributeOverrides Klasse

Definition

Ermöglicht das Überschreiben der Attribute von Eigenschaften, Feldern und Klassen beim Serialisieren oder Deserialisieren eines Objekts mit XmlSerializer.Allows you to override property, field, and class attributes when you use the XmlSerializer to serialize or deserialize an object.

public ref class XmlAttributeOverrides
public class XmlAttributeOverrides
type XmlAttributeOverrides = class
Public Class XmlAttributeOverrides
Vererbung
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.The following example serializes a class named Orchestra, which contains a single field named Instruments that returns an array of Instrument objects. Eine zweite Klasse mit dem Namen Brass erbt von der Instrument-Klasse.A second class named Brass inherits from the Instrument class. Im Beispiel wird eine Instanz der XmlAttributeOverrides-Klasse verwendet, um das Instrument Feld zu überschreiben, sodass das Feld Brass Objekte akzeptieren kann.The example uses an instance of the XmlAttributeOverrides class to override the Instrument field, allowing the field to accept Brass objects.

#using <System.Xml.dll>
#using <System.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml::Serialization;

public ref class Instrument
{
public:
   String^ Name;
};

public ref class Brass: public Instrument
{
public:
   bool IsValved;
};

public ref class Orchestra
{
public:
   array<Instrument^>^Instruments;
};

void SerializeObject( String^ filename )
{
   /* Each overridden field, property, or type requires 
      an XmlAttributes object. */
   XmlAttributes^ attrs = gcnew XmlAttributes;

   /* Create an XmlElementAttribute to override the 
      field that returns Instrument objects. The overridden field
      returns Brass objects instead. */
   XmlElementAttribute^ attr = gcnew XmlElementAttribute;
   attr->ElementName = "Brass";
   attr->Type = Brass::typeid;

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

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

   // Create the XmlSerializer using the XmlAttributeOverrides.
   XmlSerializer^ s = gcnew XmlSerializer( Orchestra::typeid,attrOverrides );

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

   // Create the object that will be serialized.
   Orchestra^ band = gcnew Orchestra;

   // Create an object of the derived type.
   Brass^ i = gcnew Brass;
   i->Name = "Trumpet";
   i->IsValved = true;
   array<Instrument^>^myInstruments = {i};
   band->Instruments = myInstruments;

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

void DeserializeObject( String^ filename )
{
   XmlAttributeOverrides^ attrOverrides = gcnew XmlAttributeOverrides;
   XmlAttributes^ attrs = gcnew XmlAttributes;

   // Create an XmlElementAttribute to override the Instrument.
   XmlElementAttribute^ attr = gcnew XmlElementAttribute;
   attr->ElementName = "Brass";
   attr->Type = Brass::typeid;

   // Add the XmlElementAttribute to the collection of objects.
   attrs->XmlElements->Add( attr );
   attrOverrides->Add( Orchestra::typeid, "Instruments", attrs );

   // Create the XmlSerializer using the XmlAttributeOverrides.
   XmlSerializer^ s = gcnew XmlSerializer( Orchestra::typeid,attrOverrides );
   FileStream^ fs = gcnew FileStream( filename,FileMode::Open );
   Orchestra^ band = dynamic_cast<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;
   System::Collections::IEnumerator^ myEnum = band->Instruments->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Instrument^ i = safe_cast<Instrument^>(myEnum->Current);
      b = dynamic_cast<Brass^>(i);
      Console::WriteLine( "{0}\n{1}", b->Name, b->IsValved );
   }
}

int main()
{
   SerializeObject( "Override.xml" );
   DeserializeObject( "Override.xml" );
}
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

Der-XmlAttributeOverrides ermöglicht es dem XmlSerializer, die Standardmethode zum Serialisieren eines Satzes von-Objekten zu überschreiben.The XmlAttributeOverrides enables the XmlSerializer to override the default way of serializing a set of objects. Das Überschreiben der Serialisierung auf diese Weise hat zwei Verwendungsmöglichkeiten: zuerst 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, die Objekte jedoch auf verschiedene Weise serialisieren.Overriding serialization in this way has two uses: first, you can control and augment the serialization of objects found in a DLL--even if you do not have access to the source; second, you can create one set of serializable classes, but serialize the objects in multiple ways. Anstatt Member einer Klasseninstanz als XML-Elemente zu serialisieren, können Sie Sie z. b. als XML-Attribute serialisieren, was zu einem effizienteren Dokument zum Transport führt.For example, instead of serializing members of a class instance as XML elements, you can serialize them as XML attributes, resulting in a more efficient document to transport.

Nachdem Sie ein XmlAttributeOverrides Objekt erstellt haben, übergeben Sie es als Argument an den XmlSerializer-Konstruktor.After you create an XmlAttributeOverrides object, you pass it as an argument to the XmlSerializer constructor. Das resultierende XmlSerializer verwendet die Daten, die im XmlAttributeOverrides enthalten sind, um Attribute zu überschreiben, die Steuern, wie Objekte serialisiert werden.The resulting XmlSerializer uses the data contained by the XmlAttributeOverrides to override attributes that control how objects are serialized. Um dies zu erreichen, enthält die XmlAttributeOverrides eine Auflistung der Objekttypen, die überschrieben werden, sowie ein XmlAttributes Objekt, das jedem überschriebenen Objekttyp zugeordnet ist.To accomplish this, the XmlAttributeOverrides contains a collection of the object types that are overridden, as well as an XmlAttributes object associated with each overridden object type. Das XmlAttributes-Objekt selbst enthält einen entsprechenden Satz von Attribut Objekten, die Steuern, wie die einzelnen Felder, Eigenschaften oder Klassen serialisiert werden.The XmlAttributes object itself contains an appropriate set of attribute objects that control how each field, property, or class is serialized.

Der Prozess zum Erstellen und Verwenden eines XmlAttributeOverrides Objekts lautet wie folgt:The process for creating and using an XmlAttributeOverrides object is as follows:

  1. Erstellen Sie ein XmlAttributes-Objekt.Create an XmlAttributes object.

  2. Erstellen Sie ein Attribut Objekt, das für das Objekt geeignet ist, das überschrieben wird.Create an attribute object that is appropriate to the object being overridden. Um z. b. ein Feld oder eine Eigenschaft zu überschreiben, erstellen Sie eine XmlElementAttributemit dem neuen, abgeleiteten Typ.For example, to override a field or property, create an XmlElementAttribute, using the new, derived type. Optional können Sie einen neuen ElementNameoder Namespace zuweisen, der den Attributnamen oder den Namespace der Basisklasse überschreibt.You can optionally assign a new ElementName, or Namespace that overrides the base class's attribute name or namespace.

  3. Fügen Sie das Attribut Objekt der entsprechenden XmlAttributes Eigenschaft oder Auflistung hinzu.Add the attribute object to the appropriate XmlAttributes property or collection. Beispielsweise würden Sie den XmlElementAttribute der XmlElements-Auflistung des XmlAttributes-Objekts hinzufügen und dabei den Elementnamen angeben, der überschrieben wird.For example, you would add the XmlElementAttribute to the XmlElements collection of the XmlAttributes object, specifying the member name that is being overridden.

  4. Erstellen Sie ein XmlAttributeOverrides-Objekt.Create an XmlAttributeOverrides object.

  5. Fügen Sie das XmlAttributes-Objekt mithilfe der Add-Methode dem XmlAttributeOverrides-Objekt hinzu.Using the Add method, add the XmlAttributes object to the XmlAttributeOverrides object. Wenn das Objekt, das überschrieben wird, ein XmlRootAttribute oder XmlTypeAttributeist, müssen Sie nur den Typ des überschriebenen Objekts angeben.If the object being overridden is an XmlRootAttribute or XmlTypeAttribute, you need only to specify the type of the overridden object. Wenn Sie jedoch ein Feld oder eine Eigenschaft überschreiben, müssen Sie auch den Namen des überschriebenen Members angeben.But if you are overriding a field or property, you must also specify the name of the overridden member.

  6. Wenn Sie die XmlSerializererstellen, übergeben Sie die XmlAttributeOverrides an den XmlSerializer-Konstruktor.When constructing the XmlSerializer, pass the XmlAttributeOverrides to the XmlSerializer constructor.

  7. Verwenden Sie die resultierende XmlSerializer, um die abgeleiteten Klassen Objekte zu serialisieren oder zu deserialisieren.Use the resulting XmlSerializer to serialize or deserialize the derived class objects.

Konstruktoren

XmlAttributeOverrides()

Initialisiert eine neue Instanz der XmlAttributeOverrides-Klasse.Initializes a new instance of the XmlAttributeOverrides class.

Eigenschaften

Item[Type, String]

Ruft das dem angegebenen (Basisklassen-)Typ zugeordnete Objekt ab.Gets the object associated with the specified (base-class) type. Durch den member-Parameter wird der zu überschreibende Member der Basisklasse angegeben.The member parameter specifies the base-class member that is overridden.

Item[Type]

Ruft das dem angegebenen Basisklassentyp zugeordnete Objekt ab.Gets the object associated with the specified, base-class, type.

Methoden

Add(Type, String, XmlAttributes)

Fügt der Auflistung von XmlAttributes-Objekten ein XmlAttributes-Objekt hinzu.Adds an XmlAttributes object to the collection of XmlAttributes objects. Der type-Parameter gibt ein Objekt an, das überschrieben werden soll.The type parameter specifies an object to be overridden. Der member-Parameter gibt den Namen des zu überschreibenden Members an.The member parameter specifies the name of a member that is overridden.

Add(Type, XmlAttributes)

Fügt der Auflistung von XmlAttributes-Objekten ein XmlAttributes-Objekt hinzu.Adds an XmlAttributes object to the collection of XmlAttributes objects. Der type-Parameter gibt ein Objekt an, das vom XmlAttributes-Objekt überschrieben werden soll.The type parameter specifies an object to be overridden by the XmlAttributes object.

Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetHashCode()

Dient als die Standard-HashfunktionServes as the default hash function.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Gilt für:

Siehe auch