XmlAttributeOverrides Klass

Definition

public ref class XmlAttributeOverrides

public class XmlAttributeOverrides

type XmlAttributeOverrides = class

Public Class XmlAttributeOverrides

Arv

Object

XmlAttributeOverrides

Exempel

I följande exempel serialiseras en klass med namnet Orchestra, som innehåller ett enda fält med namnet Instruments som returnerar en matris med Instrument objekt. En andra klass med namnet Brass ärver från Instrument klassen. I exemplet används en instans av XmlAttributeOverrides klassen för att åsidosätta Instrument fältet, vilket gör att fältet kan acceptera Brass objekt.

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

Kommentarer

XmlAttributeOverrides Gör det möjligt XmlSerializer att åsidosätta standardsättet för serialisering av en uppsättning objekt. Åsidosättande serialisering på det här sättet har två användningsområden: för det första kan du styra och utöka serialiseringen av objekt som finns i en DLL– även om du inte har åtkomst till källan. för det andra kan du skapa en uppsättning serialiserbara klasser, men serialisera objekten på flera sätt. I stället för att serialisera medlemmar i en klassinstans som XML-element kan du till exempel serialisera dem som XML-attribut, vilket resulterar i ett effektivare dokument att transportera.

När du har skapat ett XmlAttributeOverrides objekt skickar du det som ett argument till XmlSerializer konstruktorn. XmlSerializer Resultatet använder data som finns i XmlAttributeOverrides för att åsidosätta attribut som styr hur objekt serialiseras. För att åstadkomma detta XmlAttributeOverrides innehåller en samling av de objekttyper som åsidosätts, samt ett XmlAttributes objekt som är associerat med varje åsidosätter objekttyp. Själva XmlAttributes objektet innehåller en lämplig uppsättning attributobjekt som styr hur varje fält, egenskap eller klass serialiseras.

Processen för att skapa och använda ett XmlAttributeOverrides objekt är följande:

1. Skapa ett XmlAttributes objekt.

2. Skapa ett attributobjekt som är lämpligt för objektet som åsidosätts. Om du till exempel vill åsidosätta ett fält eller en egenskap skapar du en XmlElementAttribute, med hjälp av den nya härledda typen. Du kan också tilldela en ny ElementName, eller Namespace som åsidosätter basklassens attributnamn eller namnområde.

3. Lägg till attributobjektet i lämplig XmlAttributes egenskap eller samling. Du kan till exempel lägga till XmlElementAttributeXmlElements i samlingen av XmlAttributes objektet och ange det medlemsnamn som åsidosätts.

4. Skapa ett XmlAttributeOverrides objekt.

5. Med hjälp av Add metoden lägger du till objektet XmlAttributes i objektet XmlAttributeOverrides . Om objektet som åsidosättas är en XmlRootAttribute eller XmlTypeAttributebehöver du bara ange typen av det åsidosatta objektet. Men om du åsidosättar ett fält eller en egenskap måste du också ange namnet på den åsidosatta medlemmen.

6. När du skapar XmlSerializerskickar du XmlAttributeOverrides till XmlSerializer konstruktorn.

7. Använd resultatet XmlSerializer för att serialisera eller deserialisera de härledda klassobjekten.

Se även

• Deserialize(Stream)
• Serialize(TextWriter, Object)
• XmlSerializer
• XmlAttributes
• Introduktion till XML-serialisering
• Anvisningar: Ange ett alternativt elementnamn för en XML-dataström
• Kontrollera XML-serialisering med hjälp av attribut
• Exempel på XML-serialisering
• XML-schemadefinitionsverktyg (Xsd.exe)