XmlAttributeOverrides Classe

Définition

Espace de noms:

System.Xml.Serialization

Assembly:

System.Xml.XmlSerializer.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Permet de substituer des attributs de propriété, de champ et de classe lorsque vous utilisez XmlSerializer pour sérialiser ou désérialiser un objet.

C#

public class XmlAttributeOverrides

Héritage

Object

XmlAttributeOverrides

Exemples

L’exemple suivant sérialise une classe nommée Orchestra, qui contient un seul champ nommé Instruments qui retourne un tableau d’objets Instrument . Une deuxième classe nommée Brass hérite de la Instrument classe. L’exemple utilise une instance de la XmlAttributeOverrides classe pour remplacer le Instrument champ, ce qui permet au champ d’accepter Brass des objets.

C#

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);
      }
   }
}

Remarques

Permet XmlAttributeOverrides de XmlSerializer remplacer la méthode par défaut de sérialisation d’un ensemble d’objets. La substitution de la sérialisation de cette façon a deux utilisations : tout d’abord, vous pouvez contrôler et augmenter la sérialisation des objets trouvés dans une DLL, même si vous n’avez pas accès à la source ; ensuite, vous pouvez créer un ensemble de classes sérialisables, mais sérialiser les objets de plusieurs façons. Par exemple, au lieu de sérialiser des membres d’une instance de classe en tant qu’éléments XML, vous pouvez les sérialiser en tant qu’attributs XML, ce qui entraîne un transport plus efficace.

Après avoir créé un XmlAttributeOverrides objet, vous le transmettez en tant qu’argument au XmlSerializer constructeur. Le résultat XmlSerializer utilise les données contenues par les XmlAttributeOverrides attributs de remplacement qui contrôlent la façon dont les objets sont sérialisés. Pour ce faire, il XmlAttributeOverrides contient une collection des types d’objets substitués, ainsi qu’un XmlAttributes objet associé à chaque type d’objet substitué. L’objet XmlAttributes lui-même contient un ensemble approprié d’objets d’attribut qui contrôlent la façon dont chaque champ, propriété ou classe est sérialisé.

Le processus de création et d’utilisation d’un XmlAttributeOverrides objet est le suivant :

1. Créez un objet XmlAttributes.

2. Créez un objet d’attribut approprié à l’objet en cours de substitution. Par exemple, pour remplacer un champ ou une propriété, créez un XmlElementAttribute, à l’aide du nouveau type dérivé. Vous pouvez éventuellement affecter un nouveau ElementName, ou Namespace qui remplace le nom ou l’espace de noms de l’attribut de la classe de base.

3. Ajoutez l’objet d’attribut à la propriété ou à la collection appropriée XmlAttributes . Par exemple, vous devez ajouter la XmlElementAttribute XmlElements collection de l’objet XmlAttributes , en spécifiant le nom du membre en cours de substitution.

4. Créez un objet XmlAttributeOverrides.

5. À l’aide de la Add méthode, ajoutez l’objet XmlAttributes à l’objet XmlAttributeOverrides . Si l’objet en cours de substitution est un XmlRootAttribute ou XmlTypeAttribute, vous devez uniquement spécifier le type de l’objet substitué. Toutefois, si vous remplacez un champ ou une propriété, vous devez également spécifier le nom du membre substitué.

6. Lors de la construction, XmlSerializerpassez le XmlAttributeOverrides XmlSerializer constructeur.

7. Utilisez le résultat XmlSerializer pour sérialiser ou désérialiser les objets de classe dérivée.

Constructeurs

XmlAttributeOverrides()

Initialise une nouvelle instance de la classe XmlAttributeOverrides.

Propriétés

Item[Type, String]	Obtient l'objet associé au type spécifié de classe de base. Le paramètre relatif au membre indique le membre de la classe de base qui est substitué.
Item[Type]	Obtient l'objet associé au type spécifié de classe de base.

Méthodes

Add(Type, String, XmlAttributes)	Ajoute un objet XmlAttributes à la collection d'objets XmlAttributes. Le paramètre type spécifie l'objet qui sera substitué. Le paramètre member spécifie le nom du membre à substituer.
Add(Type, XmlAttributes)	Ajoute un objet XmlAttributes à la collection d'objets XmlAttributes. Le paramètre type spécifie l'objet auquel se substituera l'objet XmlAttributes.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

S’applique à

Voir aussi

• Deserialize(Stream)
• Serialize(TextWriter, Object)
• XmlSerializer
• XmlAttributes
• Introduction à la sérialisation XML
• Comment : spécifier un nom d'élément différent pour un flux XML
• Contrôle de la sérialisation XML à l'aide d'attributs
• Exemples de sérialisation XML
• Outil XML Schema Definition (Xsd.exe)