XmlAttributes Osztály

Definíció

Névtér:

System.Xml.Serialization

Szerelvények:

netstandard.dll, System.Xml.XmlSerializer.dll

Forrás:

XmlAttributes.cs

Attribútumobjektumok gyűjteményét jelöli, amelyek szabályozzák, XmlSerializer hogyan szerializálja és deszerializálja az objektumokat.

public ref class XmlAttributes

public class XmlAttributes

type XmlAttributes = class

Public Class XmlAttributes

Öröklődés

Object

XmlAttributes

Példák

Az alábbi példa szerializálja a nevesített Orchestraosztály egy példányát, amely egyetlen, objektumtömböt Instruments visszaadó mezőt Instrument tartalmaz. A második osztály neve Brass öröklődik az Instrument osztálytól. A példa létrehoz egy XmlAttributes objektumot a Instrument mező felülbírálásához – lehetővé téve a mező számára az objektumok elfogadását Brass –, és hozzáadja az XmlAttributes objektumot az XmlAttributeOverrides osztály egy példányához.

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

Megjegyzések

A XmlAttributes létrehozás egy folyamat része, amely felülírja az osztálypéldányok szerializálásának XmlSerializer alapértelmezett módját. Tegyük fel például, hogy egy elérhetetlen forrással rendelkező DLL-ből létrehozott objektumot szeretne szerializálni. A használatával XmlAttributeOverridesbővítheti vagy egyéb módon szabályozhatja az objektum szerializálását.

Az osztály tagjai XmlAttributes közvetlenül a szerializálást vezérlő attribútumosztályok családjának felelnek meg. A tulajdonságot például egy XmlTextolyan értékre kell beállítani, XmlTextAttribute amely lehetővé teszi egy mező vagy tulajdonság szerializálásának felülbírálását azáltal, hogy a XmlSerializer tulajdonság értékét XML-szövegként szerializálja. A szerializálást vezérlő attribútumok teljes listáját a XmlSerializer.

Az osztály használatával XmlAttributeOverridesXmlAttributes kapcsolatos további részletekért lásd: Útmutató: Alternatív elemnév megadása XML-adatfolyamhoz.

Konstruktorok

Name	Description
XmlAttributes()	Inicializálja a XmlAttributes osztály új példányát.
XmlAttributes(ICustomAttributeProvider)	Inicializálja az XmlAttributes osztály új példányát, és testre szabja, XmlSerializer hogyan szerializálja és deszerializálja az objektumot.

Tulajdonságok

Name	Description
XmlAnyAttribute	Lekéri vagy beállítja a XmlAnyAttributeAttribute felülbírálást.
XmlAnyElements	Lekéri a felülbírálandó objektumok gyűjteményét XmlAnyElementAttribute .
XmlArray	Lekéri vagy beállít egy objektumot, amely meghatározza, hogy a szerializálja a XmlSerializer tömböt visszaadó nyilvános mezőt vagy olvasási/írási tulajdonságot.
XmlArrayItems	Lekéri vagy beállít egy objektumgyűjteményt, amely meghatározza, hogyan szerializálja a XmlSerializer nyilvános mező vagy írási/olvasási tulajdonság által visszaadott tömbbe beszúrt elemeket.
XmlAttribute	Lekéri vagy beállít egy objektumot, amely meghatározza, hogyan XmlSerializer szerializál egy nyilvános mezőt vagy egy nyilvános olvasási/írási tulajdonságot XML-attribútumként.
XmlChoiceIdentifier	Lekéri vagy beállít egy objektumot, amely lehetővé teszi a választási lehetőségek halmazának megkülönböztetésére.
XmlDefaultValue	Lekéri vagy beállítja egy XML-elem vagy attribútum alapértelmezett értékét.
XmlElements	Lekéri azokat az objektumgyűjteményeket, amelyek meghatározzák, hogyan szerializálja a XmlSerializer nyilvános mezőt vagy az olvasási/írási tulajdonságot XML-elemként.
XmlEnum	Lekéri vagy beállít egy objektumot, amely meghatározza, XmlSerializer hogyan szerializál egy számbavételi tagot.
XmlIgnore	Lekéri vagy beállít egy értéket, amely meghatározza, hogy a szerializálja-e a nyilvános mezőt vagy a XmlSerializer nyilvános olvasási/írási tulajdonságot.
Xmlns	Lekéri vagy beállít egy értéket, amely meghatározza, hogy megtartja-e az összes névtér-deklarációt, ha egy objektumot visszaadó XmlSerializerNamespaces tagot tartalmazó objektum felül lesz bírálva.
XmlRoot	Lekéri vagy beállít egy objektumot, amely meghatározza, hogyan XmlSerializer szerializál egy osztályt XML-gyökérelemként.
XmlText	Lekéri vagy beállít egy objektumot, amely arra utasítja, XmlSerializer hogy szerializáljon egy nyilvános mezőt vagy egy nyilvános olvasási/írási tulajdonságot XML-szövegként.
XmlType	Lekéri vagy beállít egy objektumot, amely meghatározza, hogyan XmlSerializer szerializál egy osztályt, amelyre az XmlTypeAttribute alkalmazás megtörtént.

Metódusok

Name	Description
Equals(Object)	Meghatározza, hogy a megadott objektum egyenlő-e az aktuális objektummal. (Öröklődés forrása Object)
GetHashCode()	Ez az alapértelmezett kivonatoló függvény. (Öröklődés forrása Object)
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)

Lásd még

• XmlAttributeOverrides
• XmlSerializer
• Az XML-szerializálás bemutatása
• Útmutató: Alternatív elemnév megadása XML-adatfolyamhoz
• XML-szerializálás szabályozása attribútumokkal
• Példák XML-szerializálásra
• XML-sémadefiníciós eszköz (Xsd.exe)