Freigeben über


XmlAttributes Klasse

Definition

Stellt eine Auflistung von Attributobjekten dar, die steuern, wie das XmlSerializer Objekt serialisiert und deserialisiert wird.

public ref class XmlAttributes
public class XmlAttributes
type XmlAttributes = class
Public Class XmlAttributes
Vererbung
XmlAttributes

Beispiele

Im folgenden Beispiel wird eine Instanz einer 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 ein XmlAttributes Objekt erstellt, mit dem das Instrument Feld außer Kraft gesetzt wird, sodass das Feld Objekte akzeptiert Brass , und das XmlAttributes Objekt wird einer Instanz der XmlAttributeOverrides Klasse hinzugefügt.

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 element to the collection of elements.
      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);
      }
   }
}
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(ByVal 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 element to the collection of elements.
        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.ToString())
        Next i
    End Sub
End Class

Hinweise

Das Erstellen ist XmlAttributes Teil eines Prozesses, der die Standardweise überschreibt, wie klasseninstanzen XmlSerializer serialisiert werden. Angenommen, Sie möchten ein Objekt serialisieren, das aus einer DLL erstellt wird, auf die nicht zugegriffen werden kann. Mithilfe des XmlAttributeOverrides-Objekts können Sie die Serialisierung des Objekts erweitern oder anderweitig steuern.

Die Member der XmlAttributes Klasse entsprechen direkt einer Familie von Attributklassen, die die Serialisierung steuern. Die Eigenschaft muss beispielsweise auf eine XmlTextAttributeEigenschaft festgelegt werden, XmlText mit der Sie die Serialisierung eines Felds oder einer Eigenschaft außer Kraft setzen können, indem Sie den XmlSerializer Eigenschaftswert als XML-Text serialisieren. Eine vollständige Liste der Attribute, die die Serialisierung steuern, finden Sie unter .XmlSerializer

Weitere Informationen zur Verwendung der XmlAttributeOverridesXmlAttributes Klasse finden Sie unter How to: Specify an Alternate Element Name for an XML Stream.

Konstruktoren

Name Beschreibung
XmlAttributes()

Initialisiert eine neue Instanz der XmlAttributes-Klasse.

XmlAttributes(ICustomAttributeProvider)

Initialisiert eine neue Instanz der XmlAttributes Klasse und passt an, wie das XmlSerializer Objekt serialisiert und deserialisiert wird.

Eigenschaften

Name Beschreibung
XmlAnyAttribute

Dient zum Abrufen oder Festlegen der XmlAnyAttributeAttribute Außerkraftsetzung.

XmlAnyElements

Ruft die Auflistung von XmlAnyElementAttribute Objekten ab, die außer Kraft setzen sollen.

XmlArray

Dient zum Abrufen oder Festlegen eines Objekts, das angibt, wie das XmlSerializer öffentliche Feld oder eine Lese-/Schreibeigenschaft serialisiert wird, die ein Array zurückgibt.

XmlArrayItems

Dient zum Abrufen oder Festlegen einer Auflistung von Objekten, die angeben, wie elemente XmlSerializer in ein Array eingefügt werden, das von einem öffentlichen Feld oder einer Lese-/Schreibeigenschaft zurückgegeben wird.

XmlAttribute

Dient zum Abrufen oder Festlegen eines Objekts, das angibt, wie das XmlSerializer öffentliche Feld oder eine öffentliche Lese-/Schreibeigenschaft als XML-Attribut serialisiert wird.

XmlChoiceIdentifier

Dient zum Abrufen oder Festlegen eines Objekts, mit dem Sie zwischen einer Reihe von Auswahlmöglichkeiten unterscheiden können.

XmlDefaultValue

Dient zum Abrufen oder Festlegen des Standardwerts eines XML-Elements oder -Attributs.

XmlElements

Ruft eine Auflistung von Objekten ab, die angeben, wie das XmlSerializer öffentliche Feld oder eine Lese-/Schreibeigenschaft als XML-Element serialisiert wird.

XmlEnum

Dient zum Abrufen oder Festlegen eines Objekts, das angibt, wie das XmlSerializer Enumerationselement serialisiert wird.

XmlIgnore

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das XmlSerializer öffentliche Feld oder eine öffentliche Lese-/Schreibeigenschaft serialisiert wird.

Xmlns

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob alle Namespacedeklarationen beibehalten werden sollen, wenn ein Objekt, das ein Element enthält XmlSerializerNamespaces , überschrieben wird.

XmlRoot

Dient zum Abrufen oder Festlegen eines Objekts, das angibt, wie die XmlSerializer Klasse als XML-Stammelement serialisiert wird.

XmlText

Dient zum Abrufen oder Festlegen eines Objekts, das die XmlSerializer Serialisierung eines öffentlichen Felds oder einer öffentlichen Lese-/Schreibeigenschaft als XML-Text anweist.

XmlType

Dient zum Abrufen oder Festlegen eines Objekts, das angibt, wie die XmlSerializer Klasse serialisiert wird, auf die die XmlTypeAttribute Klasse angewendet wurde.

Methoden

Name Beschreibung
Equals(Object)

Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht.

(Geerbt von Object)
GetHashCode()

Dient als Standardhashfunktion.

(Geerbt von Object)
GetType()

Ruft die Type der aktuellen Instanz ab.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie der aktuellen Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

(Geerbt von Object)

Gilt für:

Weitere Informationen