XmlAttributeOverrides Klas

Definitie

public ref class XmlAttributeOverrides

public class XmlAttributeOverrides

type XmlAttributeOverrides = class

Public Class XmlAttributeOverrides

Overname

Object

XmlAttributeOverrides

Voorbeelden

In het volgende voorbeeld wordt een klasse met de naam Orchestrageserialiseerd, die één veld Instruments bevat dat een matrix met Instrument objecten retourneert. Een tweede klasse met de naam Brass neemt over van de Instrument klasse. In het voorbeeld wordt een exemplaar van de XmlAttributeOverrides klasse gebruikt om het Instrument veld te overschrijven, zodat het veld objecten kan accepteren Brass .

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

Opmerkingen

Hiermee XmlAttributeOverrides kan de XmlSerializer standaardwijze voor het serialiseren van een set objecten worden overschreven. Het overschrijven van serialisatie op deze manier heeft twee toepassingen: eerst kunt u de serialisatie van objecten in een DLL beheren en verbeteren, zelfs als u geen toegang hebt tot de bron; Ten tweede kunt u één set serialiseerbare klassen maken, maar de objecten op meerdere manieren serialiseren. In plaats van leden van een klasse-exemplaar als XML-elementen te serialiseren, kunt u ze bijvoorbeeld serialiseren als XML-kenmerken, wat resulteert in een efficiënter document voor transport.

Nadat u een XmlAttributeOverrides object hebt gemaakt, geeft u het als argument door aan de XmlSerializer constructor. De resulterende XmlSerializer gegevens worden gebruikt door de XmlAttributeOverrides kenmerken te overschrijven die bepalen hoe objecten worden geserialiseerd. Hiervoor bevat de XmlAttributeOverrides verzameling objecttypen die worden overschreven, evenals een XmlAttributes object dat is gekoppeld aan elk overschreven objecttype. Het XmlAttributes object zelf bevat een geschikte set kenmerkobjecten die bepalen hoe elk veld, elke eigenschap of klasse wordt geserialiseerd.

Het proces voor het maken en gebruiken van een XmlAttributeOverrides object is als volgt:

1. Maak een XmlAttributes object.

2. Maak een kenmerkobject dat geschikt is voor het object dat wordt overschreven. Als u bijvoorbeeld een veld of eigenschap wilt overschrijven, maakt u een XmlElementAttribute, met behulp van het nieuwe, afgeleide type. U kunt desgewenst een nieuwe ElementNameNamespace naam of naamruimte toewijzen die de kenmerknaam of naamruimte van de basisklasse overschrijft.

3. Voeg het kenmerkobject toe aan de juiste XmlAttributes eigenschap of verzameling. U voegt bijvoorbeeld de XmlElementAttribute verzameling XmlElements van het XmlAttributes object toe, waarbij u de lidnaam opgeeft die wordt overschreven.

4. Maak een XmlAttributeOverrides object.

5. Voeg met behulp van de Add methode het XmlAttributes object toe aan het XmlAttributeOverrides object. Als het object dat wordt overschreven een XmlRootAttribute of XmlTypeAttributeis, hoeft u alleen het type van het overschreven object op te geven. Maar als u een veld of eigenschap overschrijft, moet u ook de naam van het overschreven lid opgeven.

6. Geef bij het maken van de XmlSerializerconstructor de XmlAttributeOverrides aan de XmlSerializer constructor door.

7. Gebruik het resultaat XmlSerializer om de afgeleide klasseobjecten te serialiseren of deserialiseren.

Zie ook

• Deserialize(Stream)
• Serialize(TextWriter, Object)
• XmlSerializer
• XmlAttributes
• Inleiding tot XML-serialisatie
• Procedure: Geef een alternatieve elementnaam op voor een XML-stream
• XML-serialisatie beheren met behulp van kenmerken
• Voorbeelden van XML-serialisatie
• Xml Schema Definition Tool (Xsd.exe)