XmlSerializer Constructeurs

Définition

Espace de noms:

System.Xml.Serialization

Assembly:

System.Xml.XmlSerializer.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Initialise une nouvelle instance de la classe XmlSerializer.

Surcharges

XmlSerializer()	Initialise une nouvelle instance de la classe XmlSerializer.
XmlSerializer(Type)	Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié.
XmlSerializer(XmlTypeMapping)	Initialise une instance de la classe XmlSerializer à l'aide d'un objet qui établit une correspondance entre les types.
XmlSerializer(Type, String)	Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Spécifie l'espace de noms par défaut de tous les éléments XML.
XmlSerializer(Type, Type[])	Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Si une propriété ou un champ retourne un tableau, le paramètre extraTypes spécifie les objets pouvant être insérés dans ce tableau.
XmlSerializer(Type, XmlAttributeOverrides)	Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Chaque objet à sérialiser peut lui-même contenir des instances de classes auxquelles cette surcharge peut substituer d'autres classes.
XmlSerializer(Type, XmlRootAttribute)	Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Spécifie également la classe à utiliser en tant qu'élément racine XML.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String)	Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type Object en documents XML et désérialiser, les documents XML en objets du type Object. Chaque objet à sérialiser peut lui-même contenir des instances de classes auxquelles cette surcharge peut substituer d'autres classes. Cette surcharge spécifie également l'espace de noms par défaut de tous les éléments XML ainsi que la classe à utiliser en tant qu'élément racine XML.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String)	Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type Object en documents XML et désérialiser, les documents XML en objets du type Object. Chaque objet à sérialiser peut lui-même contenir des instances de classes auxquelles cette surcharge peut substituer d'autres classes. Cette surcharge spécifie également l'espace de noms par défaut de tous les éléments XML ainsi que la classe à utiliser en tant qu'élément racine XML.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String, Evidence)	Obsolète. Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Cette surcharge vous permet de fournir d'autres types qui peuvent être rencontrés pendant une sérialisation ou une désérialisation, ainsi qu'un espace de noms par défaut pour tous les éléments XML, la classe à utiliser comme élément racine XML, son emplacement et les informations d'identification requises pour y accéder.

XmlSerializer()

Initialise une nouvelle instance de la classe XmlSerializer.

C#

protected XmlSerializer ();

XmlSerializer(Type)

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié.

C#

public XmlSerializer (Type type);

Paramètres

type

Type

Type de l'objet que XmlSerializer peut sérialiser.

Exemples

L’exemple suivant construit un XmlSerializer objet nommé Widget. L’exemple définit différentes propriétés de l’objet avant d’appeler la Serialize méthode.

C#

private void SerializeObject(string filename)
{
   XmlSerializer serializer =
   new XmlSerializer(typeof(OrderedItem));

   // Create an instance of the class to be serialized.
   OrderedItem i = new OrderedItem();

   // Set the public property values.
   i.ItemName = "Widget";
   i.Description = "Regular Widget";
   i.Quantity = 10;
   i.UnitPrice = (decimal) 2.30;

   // Writing the document requires a TextWriter.
   TextWriter writer = new StreamWriter(filename);

   // Serialize the object, and close the TextWriter.
   serializer.Serialize(writer, i);
   writer.Close();
}

// This is the class that will be serialized.
public class OrderedItem
{
   public string ItemName;
   public string Description;
   public decimal UnitPrice;
   public int Quantity;
}

Remarques

En règle générale, une application définit plusieurs classes que les XmlSerializer convertissent en un seul document d’instance XML. Toutefois, il XmlSerializer ne doit connaître qu’un seul type de la classe qui représente l’élément racine XML. Sérialise XmlSerializer automatiquement toutes les instances de classe subordonnées. De même, seul le type de l’élément racine XML est requis pour la désérialisation.

Voir aussi

• Serialize(TextWriter, Object)
• Deserialize(Stream)
• 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)

XmlSerializer(XmlTypeMapping)

Initialise une instance de la classe XmlSerializer à l'aide d'un objet qui établit une correspondance entre les types.

C#

public XmlSerializer (System.Xml.Serialization.XmlTypeMapping xmlTypeMapping);

Paramètres

xmlTypeMapping

XmlTypeMapping

XmlTypeMapping qui établit une correspondance entre les types.

Exemples

L’exemple suivant sérialise une classe nommée Group. La sérialisation des GroupNamechamps et IgnoreThis des membres de l’énumération GroupType est remplacée. Dans la CreateOverrideSerializer méthode, un SoapAttributeOverrides objet est créé et, pour chaque membre ou énumération substitué, un SoapAttributes objet est créé avec le jeu de propriétés approprié et ajouté à l’objet SoapAttributeOverrides . Un XmlMapping objet est créé à l’aide de l’objet SoapAttributeOverrides et cet XmlMapping objet est utilisé pour créer celui XmlSerializer qui remplace la sérialisation par défaut.

C#

using System;
using System.IO;
using System.Text;
using System.Xml;
using System.Xml.Serialization;
using System.Xml.Schema;

public class Group
{
   [SoapAttribute (Namespace = "http://www.cpandl.com")]
   public string GroupName;

   [SoapAttribute(DataType = "base64Binary")]
   public Byte [] GroupNumber;

   [SoapAttribute(DataType = "date", AttributeName = "CreationDate")]
   public DateTime Today;
   [SoapElement(DataType = "nonNegativeInteger", ElementName = "PosInt")]
   public string PostitiveInt;
   // This is ignored when serialized unless it's overridden.
   [SoapIgnore]
   public bool IgnoreThis;

   public GroupType Grouptype;

   public Vehicle MyVehicle;

   // The SoapInclude allows the method to return a Car.
   [SoapInclude(typeof(Car))]
   public Vehicle myCar(string licNumber)
   {
      Vehicle v;
      if(licNumber == "")
         {
            v = new Car();
        v.licenseNumber = "!!!!!!";
     }
      else
     {
       v = new Car();
       v.licenseNumber = licNumber;
     }
      return v;
   }
}

// SoapInclude allows Vehicle to accept Car type.
[SoapInclude(typeof(Car))]
public abstract class Vehicle
{
   public string licenseNumber;
   public DateTime makeDate;
}

public class Car: Vehicle
{
}

public enum GroupType
{
   // These enums can be overridden.
   [SoapEnum("Small")]
   A,
   [SoapEnum("Large")]
   B
}

public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeOriginal("SoapOriginal.xml");
      test.SerializeOverride("SoapOverrides.xml");
      test.DeserializeOriginal("SoapOriginal.xml");
      test.DeserializeOverride("SoapOverrides.xml");
   }
   public void SerializeOriginal(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlTypeMapping myMapping =
      (new SoapReflectionImporter().ImportTypeMapping(
      typeof(Group)));
      XmlSerializer mySerializer =
      new XmlSerializer(myMapping);
      Group myGroup=MakeGroup();
      // Writing the file requires a TextWriter.
      XmlTextWriter writer =
      new XmlTextWriter(filename, Encoding.UTF8);
      writer.Formatting = Formatting.Indented;
      writer.WriteStartElement("wrapper");
      // Serialize the class, and close the TextWriter.
      mySerializer.Serialize(writer, myGroup);
      writer.WriteEndElement();
      writer.Close();
   }

   public void SerializeOverride(string filename)
   {
      // Create an instance of the XmlSerializer class
      // that overrides the serialization.
      XmlSerializer overRideSerializer = CreateOverrideSerializer();
      Group myGroup=MakeGroup();
      // Writing the file requires a TextWriter.
      XmlTextWriter writer =
      new XmlTextWriter(filename, Encoding.UTF8);
      writer.Formatting = Formatting.Indented;
      writer.WriteStartElement("wrapper");
      // Serialize the class, and close the TextWriter.
      overRideSerializer.Serialize(writer, myGroup);
      writer.WriteEndElement();
      writer.Close();
   }

   private Group MakeGroup(){
      // Create an instance of the class that will be serialized.
      Group myGroup = new Group();

      // Set the object properties.
      myGroup.GroupName = ".NET";

      Byte [] hexByte = new Byte[2]{Convert.ToByte(100),
      Convert.ToByte(50)};
      myGroup.GroupNumber = hexByte;

      DateTime myDate = new DateTime(2002,5,2);
      myGroup.Today = myDate;
      myGroup.PostitiveInt= "10000";
      myGroup.IgnoreThis=true;
      myGroup.Grouptype= GroupType.B;
      Car thisCar =(Car)  myGroup.myCar("1234566");
      myGroup.MyVehicle=thisCar;
      return myGroup;
   }   	

   public void DeserializeOriginal(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlTypeMapping myMapping =
      (new SoapReflectionImporter().ImportTypeMapping(
      typeof(Group)));
      XmlSerializer mySerializer =
      new XmlSerializer(myMapping);

      // Reading the file requires an  XmlTextReader.
      XmlTextReader reader=
      new XmlTextReader(filename);
      reader.ReadStartElement("wrapper");

      // Deserialize and cast the object.
      Group myGroup;
      myGroup = (Group) mySerializer.Deserialize(reader);
      reader.ReadEndElement();
      reader.Close();
   }

   public void DeserializeOverride(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer overRideSerializer = CreateOverrideSerializer();

      // Reading the file requires an  XmlTextReader.
      XmlTextReader reader=
      new XmlTextReader(filename);
      reader.ReadStartElement("wrapper");

      // Deserialize and cast the object.
      Group myGroup;
      myGroup = (Group) overRideSerializer.Deserialize(reader);
      reader.ReadEndElement();
      reader.Close();
      ReadGroup(myGroup);
   }

   private void ReadGroup(Group myGroup){
      Console.WriteLine(myGroup.GroupName);
      Console.WriteLine(myGroup.GroupNumber[0]);
      Console.WriteLine(myGroup.GroupNumber[1]);
      Console.WriteLine(myGroup.Today);
      Console.WriteLine(myGroup.PostitiveInt);
      Console.WriteLine(myGroup.IgnoreThis);
      Console.WriteLine();
   }
   private XmlSerializer CreateOverrideSerializer()
   {
      SoapAttributeOverrides mySoapAttributeOverrides =
      new SoapAttributeOverrides();
      SoapAttributes soapAtts = new SoapAttributes();

      SoapElementAttribute mySoapElement = new SoapElementAttribute();
      mySoapElement.ElementName = "xxxx";
      soapAtts.SoapElement = mySoapElement;
      mySoapAttributeOverrides.Add(typeof(Group), "PostitiveInt",
      soapAtts);

      // Override the IgnoreThis property.
      SoapIgnoreAttribute myIgnore = new SoapIgnoreAttribute();
      soapAtts = new SoapAttributes();
      soapAtts.SoapIgnore = false;
      mySoapAttributeOverrides.Add(typeof(Group), "IgnoreThis",
      soapAtts);

      // Override the GroupType enumeration.	
      soapAtts = new SoapAttributes();
      SoapEnumAttribute xSoapEnum = new SoapEnumAttribute();
      xSoapEnum.Name = "Over1000";
      soapAtts.SoapEnum = xSoapEnum;

      // Add the SoapAttributes to the
      // mySoapAttributeOverridesrides object.
      mySoapAttributeOverrides.Add(typeof(GroupType), "A",
      soapAtts);

      // Create second enumeration and add it.
      soapAtts = new SoapAttributes();
      xSoapEnum = new SoapEnumAttribute();
      xSoapEnum.Name = "ZeroTo1000";
      soapAtts.SoapEnum = xSoapEnum;
      mySoapAttributeOverrides.Add(typeof(GroupType), "B",
      soapAtts);

      // Override the Group type.
      soapAtts = new SoapAttributes();
      SoapTypeAttribute soapType = new SoapTypeAttribute();
      soapType.TypeName = "Team";
      soapAtts.SoapType = soapType;
      mySoapAttributeOverrides.Add(typeof(Group),soapAtts);

      // Create an XmlTypeMapping that is used to create an instance
      // of the XmlSerializer. Then return the XmlSerializer object.
      XmlTypeMapping myMapping = (new SoapReflectionImporter(
      mySoapAttributeOverrides)).ImportTypeMapping(typeof(Group));
    
      XmlSerializer ser = new XmlSerializer(myMapping);
      return ser;
   }
}

Remarques

Ce constructeur est utilisé pour créer un objet lors de XmlSerializer la sérialisation d’un objet dans un message SOAP. Pour contrôler les messages SOAP générés, utilisez les attributs spéciaux (en commençant par le mot « Soap ») trouvé dans l’espace System.Xml.Serialization de noms.

Voir aussi

• 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)

XmlSerializer(Type, String)

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Spécifie l'espace de noms par défaut de tous les éléments XML.

C#

public XmlSerializer (Type type, string defaultNamespace);

C#

public XmlSerializer (Type type, string? defaultNamespace);

Paramètres

type

Type

Type de l'objet que XmlSerializer peut sérialiser.

defaultNamespace

String

Espace de noms par défaut à utiliser pour tous les éléments XML.

Exemples

L’exemple suivant construit un XmlSerializer objet nommé Widget. L’exemple définit différentes propriétés de l’objet avant d’appeler la Serialize méthode.

C#

private void SerializeObject(string filename) {
    XmlSerializer serializer = new XmlSerializer
        (typeof(OrderedItem), "http://www.cpandl.com");

    // Create an instance of the class to be serialized.
    OrderedItem i = new OrderedItem();

    // Insert code to set property values.

    // Writing the document requires a TextWriter.
    TextWriter writer = new StreamWriter(filename);
    // Serialize the object, and close the TextWriter
    serializer.Serialize(writer, i);
    writer.Close();
}

private void DeserializeObject(string filename) {
    XmlSerializer serializer = new XmlSerializer
        (typeof(OrderedItem), "http://www.cpandl.com");
    // A FileStream is needed to read the XML document.
    FileStream fs = new FileStream(filename, FileMode.Open);

    // Declare an object variable of the type to be deserialized.
    OrderedItem i;

    // Deserialize the object.
    i = (OrderedItem) serializer.Deserialize(fs);

    // Insert code to use the properties and methods of the object.
}

Voir aussi

• 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)

XmlSerializer(Type, Type[])

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Si une propriété ou un champ retourne un tableau, le paramètre extraTypes spécifie les objets pouvant être insérés dans ce tableau.

C#

public XmlSerializer (Type type, Type[] extraTypes);

C#

public XmlSerializer (Type type, Type[]? extraTypes);

Paramètres

type

Type

Type de l'objet que XmlSerializer peut sérialiser.

extraTypes

Type[]

Tableau Type de types d'objets supplémentaires à sérialiser.

Exemples

L’exemple suivant sérialise une instance d’une classe qui contient un champ public qui retourne un tableau d’objets. Le extraTypes paramètre du XmlSerializer constructeur spécifie les types des objets qui peuvent être sérialisés dans le tableau.

C#

using System;
using System.IO;
using System.Xml;
using System.Xml.Serialization;

// This defines the object that will be serialized.
public class Teacher
{
   public string Name;
   public Teacher(){}
   /* Note that the Info field returns an array of objects.
      Any object can be added to the array by adding the
      object type to the array passed to the extraTypes argument. */
   [XmlArray (ElementName = "ExtraInfo", IsNullable = true)]
   public object[] Info;
   public Phone PhoneInfo;
}

// This defines one of the extra types to be included.
public class Address
{
   public string City;

   public Address(){}
   public Address(string city)
   {
      City = city;
   }
}

// Another extra type to include.
public class Phone
{
   public string PhoneNumber;
   public Phone(){}
   public Phone(string phoneNumber)
   {
      PhoneNumber = phoneNumber;
   }
}

// Another type, derived from Phone
public class InternationalPhone:Phone
{
   public string CountryCode;

   public InternationalPhone(){}

   public InternationalPhone(string countryCode)
   {
      CountryCode = countryCode;
   }
}

public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeObject("Teacher.xml");
      test.DeserializeObject("Teacher.xml");
   }

   private void SerializeObject(string filename)
   {
      // Writing the file requires a TextWriter.
      TextWriter myStreamWriter = new StreamWriter(filename);

      // Create a Type array.
      Type [] extraTypes= new Type[3];
      extraTypes[0] = typeof(Address);
      extraTypes[1] = typeof(Phone);
      extraTypes[2] = typeof(InternationalPhone);

      // Create the XmlSerializer instance.
      XmlSerializer mySerializer = new XmlSerializer
      (typeof(Teacher),extraTypes);

      Teacher teacher = new Teacher();
      teacher.Name = "Mike";
      // Add extra types to the Teacher object
      object [] info = new object[2];
      info[0] = new Address("Springville");
      info[1] = new Phone("555-0100");

      teacher.Info = info;

      teacher.PhoneInfo = new InternationalPhone("000");

      mySerializer.Serialize(myStreamWriter,teacher);
      myStreamWriter.Close();
   }

   private void DeserializeObject(string filename)
   {
      // Create a Type array.
      Type [] extraTypes= new Type[3];
      extraTypes[0] = typeof(Address);
      extraTypes[1] = typeof(Phone);
      extraTypes[2] = typeof(InternationalPhone);

      // Create the XmlSerializer instance.
      XmlSerializer mySerializer = new XmlSerializer
      (typeof(Teacher),extraTypes);

      // Reading a file requires a FileStream.
      FileStream fs = new FileStream(filename, FileMode.Open);
      Teacher teacher = (Teacher) mySerializer.Deserialize(fs);

      // Read the extra information.
      Address a = (Address)teacher.Info[0];
      Phone p = (Phone) teacher.Info[1];
      InternationalPhone Ip =
      (InternationalPhone) teacher.PhoneInfo;

      Console.WriteLine(teacher.Name);
      Console.WriteLine(a.City);
      Console.WriteLine(p.PhoneNumber);
      Console.WriteLine(Ip.CountryCode);
   }
}

Remarques

Par défaut, si une propriété ou un champ public retourne un objet ou un tableau d’objets, les types d’objets sont automatiquement sérialisés. Toutefois, si une classe contient un champ ou une propriété qui retourne un tableau de type Object, n’importe quel objet peut être inséré dans ce tableau. Dans ce cas, il XmlSerializer doit être demandé d’attendre tous les types d’objets possibles insérés dans le Object tableau. Pour ce faire, utilisez le extraTypes paramètre pour spécifier les types d’objets supplémentaires à sérialiser ou désérialiser.

Vous pouvez également utiliser le extraTypes paramètre pour spécifier des types dérivés d’une classe de base. Par exemple, supposons qu’une classe de base nommée Phone existe et qu’une classe nommée InternationalPhone dérive de celle-ci. Utilisez également le extraTypes paramètre pour spécifier le type dérivé.

Voir aussi

• 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)

XmlSerializer(Type, XmlAttributeOverrides)

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Chaque objet à sérialiser peut lui-même contenir des instances de classes auxquelles cette surcharge peut substituer d'autres classes.

C#

public XmlSerializer (Type type, System.Xml.Serialization.XmlAttributeOverrides overrides);

C#

public XmlSerializer (Type type, System.Xml.Serialization.XmlAttributeOverrides? overrides);

Paramètres

type

Type

Type de l'objet à sérialiser.

overrides

XmlAttributeOverrides

Élément XmlAttributeOverrides.

Exemples

L’exemple suivant sérialise une instance d’une classe définie dans une DLL et remplace les membres publics trouvés dans la DLL.

C#

// Beginning of HighSchool.dll
namespace HighSchool
{
   public class Student
   {
      public string Name;
      public int ID;
   }

   public class MyClass
   {
      public Student[] Students;
   }
}

namespace College
   {
   using System;
   using System.IO;
   using System.Xml;
   using System.Xml.Serialization;
   using HighSchool;

    public class Graduate:HighSchool.Student
    {
       public Graduate(){}
       // Add a new field named University.
       public string University;
    }

   public class Run
   {
      public static void Main()
      {
         Run test = new Run();
         test.WriteOverriddenAttributes("College.xml");
         test.ReadOverriddenAttributes("College.xml");
      }

      private void WriteOverriddenAttributes(string filename)
      {
         // Writing the file requires a TextWriter.
         TextWriter myStreamWriter = new StreamWriter(filename);
         // Create an XMLAttributeOverrides class.
         XmlAttributeOverrides attrOverrides =
         new XmlAttributeOverrides();
         // Create the XmlAttributes class.
         XmlAttributes attrs = new XmlAttributes();

         /* Override the Student class. "Alumni" is the name
         of the overriding element in the XML output. */
         XmlElementAttribute attr =
         new XmlElementAttribute("Alumni", typeof(Graduate));

         /* Add the XmlElementAttribute to the collection of
         elements in the XmlAttributes object. */
         attrs.XmlElements.Add(attr);

         /* Add the XmlAttributes to the XmlAttributeOverrides.
         "Students" is the name being overridden. */
         attrOverrides.Add(typeof(HighSchool.MyClass),
         "Students", attrs);

         // Create the XmlSerializer.
         XmlSerializer mySerializer = new XmlSerializer
         (typeof(HighSchool.MyClass), attrOverrides);

         MyClass myClass = new MyClass();

         Graduate g1 = new Graduate();
         g1.Name = "Jackie";
         g1.ID = 1;
         g1.University = "Alma Mater";

         Graduate g2 = new Graduate();
         g2.Name = "Megan";
         g2.ID = 2;
         g2.University = "CM";

         Student[] myArray = {g1,g2};
         myClass.Students = myArray;

         mySerializer.Serialize(myStreamWriter, myClass);
         myStreamWriter.Close();
      }

      private void ReadOverriddenAttributes(string filename)
      {
         /* The majority of the code here is the same as that in the
         WriteOverriddenAttributes method. Because the XML being read
         doesn't conform to the schema defined by the DLL, the
         XMLAttributesOverrides must be used to create an
         XmlSerializer instance to read the XML document.*/

         XmlAttributeOverrides attrOverrides = new
         XmlAttributeOverrides();
         XmlAttributes attrs = new XmlAttributes();
         XmlElementAttribute attr =
         new XmlElementAttribute("Alumni", typeof(Graduate));
         attrs.XmlElements.Add(attr);
         attrOverrides.Add(typeof(HighSchool.MyClass),
         "Students", attrs);

         XmlSerializer readSerializer = new XmlSerializer
         (typeof(HighSchool.MyClass), attrOverrides);

         // To read the file, a FileStream object is required.
         FileStream fs = new FileStream(filename, FileMode.Open);

         MyClass myClass;

         myClass = (MyClass) readSerializer.Deserialize(fs);

         /* Here is the difference between reading and writing an
         XML document: You must declare an object of the derived
         type (Graduate) and cast the Student instance to it.*/
         Graduate g;

         foreach(Graduate grad in myClass.Students)
         {
            g = (Graduate) grad;
            Console.Write(g.Name + "\t");
            Console.Write(g.ID + "\t");
            Console.Write(g.University + "\n");
         }
      }
   }
}

Remarques

Le overrides paramètre peut être utilisé pour contrôler la façon dont les champs et les propriétés sont encodés en XML. Ces paramètres remplacent tous les attributs qui existent déjà sur les objets. Cela peut être utile lorsque le code source ne peut pas être modifié ou que plusieurs encodages sont requis pour les mêmes classes.

Voir aussi

• XmlAttributeOverrides
• 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)

XmlSerializer(Type, XmlRootAttribute)

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Spécifie également la classe à utiliser en tant qu'élément racine XML.

C#

public XmlSerializer (Type type, System.Xml.Serialization.XmlRootAttribute root);

C#

public XmlSerializer (Type type, System.Xml.Serialization.XmlRootAttribute? root);

Paramètres

type

Type

Type de l'objet que XmlSerializer peut sérialiser.

root

XmlRootAttribute

XmlRootAttribute qui représente l'élément racine XML.

Exemples

L’exemple suivant construit un XmlSerializer qui utilise un XmlRootAttribute qui contient différentes propriétés de l’élément racine XML, telles que son espace de noms et son nom d’élément.

C#

private void SerializeObject(string filename) {
    // Create an XmlRootAttribute, and set its properties.
    XmlRootAttribute xRoot = new XmlRootAttribute();
    xRoot.ElementName = "CustomRoot";
    xRoot.Namespace = "http://www.cpandl.com";
    xRoot.IsNullable = true;

    // Construct the XmlSerializer with the XmlRootAttribute.
    XmlSerializer serializer = new XmlSerializer
        (typeof(OrderedItem),xRoot);

    // Create an instance of the object to serialize.
    OrderedItem i = new OrderedItem();
    // Insert code to set properties of the ordered item.

    // Writing the document requires a TextWriter.
    TextWriter writer = new StreamWriter(filename);

    serializer.Serialize(writer, i);
    writer.Close();
}

private void DeserializeObject(string filename) {
    // Create an XmlRootAttribute, and set its properties.
    XmlRootAttribute xRoot = new XmlRootAttribute();
    xRoot.ElementName = "CustomRoot";
    xRoot.Namespace = "http://www.cpandl.com";
    xRoot.IsNullable = true;

    XmlSerializer serializer = new XmlSerializer
        (typeof(OrderedItem),xRoot);

    // A FileStream is needed to read the XML document.
    FileStream fs = new FileStream(filename, FileMode.Open);
    // Deserialize the object.
    OrderedItem i = (OrderedItem) serializer.Deserialize(fs);
    // Insert code to use the object's properties and methods.
}

Remarques

L’élément racine d’un document XML entoure tous les autres éléments. Par défaut, l’objet spécifié par le type paramètre est sérialisé en tant qu’élément racine. Les propriétés, telles que le nom de l’élément XML de l’élément racine, sont extraites de l’objet type . Toutefois, le root paramètre vous permet de remplacer les informations de l’objet par défaut en spécifiant un XmlRootAttribute; l’objet vous permet de définir un espace de noms, un nom d’élément différent, et ainsi de suite.

Voir aussi

• 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)

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String)

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type Object en documents XML et désérialiser, les documents XML en objets du type Object. Chaque objet à sérialiser peut lui-même contenir des instances de classes auxquelles cette surcharge peut substituer d'autres classes. Cette surcharge spécifie également l'espace de noms par défaut de tous les éléments XML ainsi que la classe à utiliser en tant qu'élément racine XML.

C#

public XmlSerializer (Type type, System.Xml.Serialization.XmlAttributeOverrides overrides, Type[] extraTypes, System.Xml.Serialization.XmlRootAttribute root, string defaultNamespace);

C#

public XmlSerializer (Type type, System.Xml.Serialization.XmlAttributeOverrides? overrides, Type[]? extraTypes, System.Xml.Serialization.XmlRootAttribute? root, string? defaultNamespace);

Paramètres

type

Type

Type de l'objet que XmlSerializer peut sérialiser.

overrides

XmlAttributeOverrides

XmlAttributeOverrides qui étend ou substitue le comportement de la classe spécifiée par le paramètre type.

extraTypes

Type[]

Tableau Type de types d'objets supplémentaires à sérialiser.

root

XmlRootAttribute

XmlRootAttribute qui définit les propriétés de l'élément racine XML.

defaultNamespace

String

Espace de noms par défaut de tous les éléments XML dans le document XML.

Exemples

L’exemple suivant sérialise une instance d’une classe définie dans une DLL et, pour ce faire, remplace les membres publics trouvés dans la classe. L’exemple spécifie également un tableau de types supplémentaires, l’espace de noms par défaut pour tous les éléments XML et la classe à utiliser qui fournit les informations d’élément racine XML. L’exemple suppose que le code au début a été compilé dans une DLL nommée HighSchool.

C#

// Beginning of the HighSchool.dll

namespace HighSchool
{
   public class Student
   {
      public string Name;
      public int ID;
   }

   public class MyClass
   {
      public Student[] Students;
   }
}

namespace College
   {
   using System;
   using System.IO;
   using System.Xml;
   using System.Xml.Serialization;
   using HighSchool;

    public class Graduate:HighSchool.Student
    {
       public Graduate(){}
       // Add a new field named University.
       public string University;
       // Use extra types to use this field.
       public object[]Info;
    }

    public class Address
    {
       public string City;
    }

    public class Phone
    {
       public string Number;
    }

   public class Run
   {
      public static void Main()
      {
         Run test = new Run();
         test.WriteOverriddenAttributes("College.xml");
         test.ReadOverriddenAttributes("College.xml");
      }

      private void WriteOverriddenAttributes(string filename)
      {
         // Writing the file requires a TextWriter.
         TextWriter myStreamWriter = new StreamWriter(filename);
         // Create an XMLAttributeOverrides class.
         XmlAttributeOverrides attrOverrides =
         new XmlAttributeOverrides();
         // Create the XmlAttributes class.
         XmlAttributes attrs = new XmlAttributes();
         /* Override the Student class. "Alumni" is the name
         of the overriding element in the XML output. */

         XmlElementAttribute attr =
         new XmlElementAttribute("Alumni", typeof(Graduate));
         /* Add the XmlElementAttribute to the collection of
         elements in the XmlAttributes object. */
         attrs.XmlElements.Add(attr);
         /* Add the XmlAttributes to the XmlAttributeOverrides.
         "Students" is the name being overridden. */
         attrOverrides.Add(typeof(HighSchool.MyClass),
         "Students", attrs);

         // Create array of extra types.
         Type [] extraTypes = new Type[2];
         extraTypes[0]=typeof(Address);
         extraTypes[1]=typeof(Phone);

         // Create an XmlRootAttribute.
         XmlRootAttribute root = new XmlRootAttribute("Graduates");

         /* Create the XmlSerializer with the
         XmlAttributeOverrides object. */
         XmlSerializer mySerializer = new XmlSerializer
         (typeof(HighSchool.MyClass), attrOverrides, extraTypes,
         root, "http://www.microsoft.com");

         MyClass myClass= new MyClass();

         Graduate g1 = new Graduate();
         g1.Name = "Jacki";
         g1.ID = 1;
         g1.University = "Alma";

         Graduate g2 = new Graduate();
         g2.Name = "Megan";
         g2.ID = 2;
         g2.University = "CM";

         Student[] myArray = {g1,g2};

         myClass.Students = myArray;

         // Create extra information.
         Address a1 = new Address();
         a1.City = "Ionia";
         Address a2 = new Address();
         a2.City = "Stamford";
         Phone p1 = new Phone();
         p1.Number = "555-0101";
         Phone p2 = new Phone();
         p2.Number = "555-0100";

         Object[]o1 = new Object[2]{a1, p1};
         Object[]o2 = new Object[2]{a2,p2};

         g1.Info = o1;
         g2.Info = o2;
         mySerializer.Serialize(myStreamWriter,myClass);
         myStreamWriter.Close();
      }

      private void ReadOverriddenAttributes(string filename)
      {
         /* The majority of the code here is the same as that in the
         WriteOverriddenAttributes method. Because the XML being read
         doesn't conform to the schema defined by the DLL, the
         XMLAttributesOverrides must be used to create an
         XmlSerializer instance to read the XML document.*/

         XmlAttributeOverrides attrOverrides = new
         XmlAttributeOverrides();
         XmlAttributes attrs = new XmlAttributes();
         XmlElementAttribute attr =
         new XmlElementAttribute("Alumni", typeof(Graduate));
         attrs.XmlElements.Add(attr);
         attrOverrides.Add(typeof(HighSchool.MyClass),
         "Students", attrs);

         Type [] extraTypes = new Type[2];
         extraTypes[0] = typeof(Address);
         extraTypes[1] = typeof(Phone);

         XmlRootAttribute root = new XmlRootAttribute("Graduates");

         XmlSerializer readSerializer = new XmlSerializer
         (typeof(HighSchool.MyClass), attrOverrides, extraTypes,
         root, "http://www.microsoft.com");

         // A FileStream object is required to read the file.
         FileStream fs = new FileStream(filename, FileMode.Open);

         MyClass myClass;
         myClass = (MyClass) readSerializer.Deserialize(fs);

         /* Here is the difference between reading and writing an
         XML document: You must declare an object of the derived
         type (Graduate) and cast the Student instance to it.*/
         Graduate g;
         Address a;
         Phone p;
         foreach(Graduate grad in myClass.Students)
         {
            g = (Graduate) grad;
            Console.Write(g.Name + "\t");
            Console.Write(g.ID + "\t");
            Console.Write(g.University + "\n");
            a = (Address) g.Info[0];
            Console.WriteLine(a.City);
            p = (Phone) g.Info[1];
            Console.WriteLine(p.Number);
         }
      }
   }
}

Remarques

Le overrides paramètre permet de créer une XmlSerializer classe qui sérialise une classe qui étend ou remplace le comportement d’une classe de base. Par exemple, en fonction d’une DLL, il est possible de créer une classe qui hérite ou étend une classe contenue dans la DLL. Pour sérialiser une telle classe, vous devez utiliser une instance de la classe lors de la XmlAttributeOverrides construction du XmlSerializer. Pour plus d'informations, consultez XmlAttributeOverrides.

Par défaut, si une propriété ou un champ public retourne un objet ou un tableau d’objets, les types d’objets sont automatiquement sérialisés. Toutefois, si une classe contient un champ ou une propriété qui retourne un tableau de type Object, n’importe quel objet peut être inséré dans ce tableau. Dans ce cas, il XmlSerializer doit être demandé d’attendre tous les types d’objets possibles insérés dans le Object tableau. Pour ce faire, utilisez le extraTypes paramètre pour spécifier les types d’objets supplémentaires à sérialiser ou désérialiser.

L’élément racine d’un document XML entoure tous les autres éléments. Par défaut, l’objet spécifié par le type paramètre est sérialisé en tant qu’élément racine. Les propriétés, telles que le nom d’élément XML de l’élément racine, sont extraites de l’objet type . Toutefois, le root paramètre vous permet de remplacer les informations de l’objet par défaut en spécifiant un XmlRootAttribute; l’objet vous permet de définir un espace de noms, un nom d’élément différent, et ainsi de suite.

Utilisez le defaultName paramètre pour spécifier l’espace de noms par défaut de tous les éléments XML générés par le XmlSerializer.

Voir aussi

• XmlAttributeOverrides
• XmlRootAttribute
• 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)

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String)

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type Object en documents XML et désérialiser, les documents XML en objets du type Object. Chaque objet à sérialiser peut lui-même contenir des instances de classes auxquelles cette surcharge peut substituer d'autres classes. Cette surcharge spécifie également l'espace de noms par défaut de tous les éléments XML ainsi que la classe à utiliser en tant qu'élément racine XML.

C#

public XmlSerializer (Type type, System.Xml.Serialization.XmlAttributeOverrides? overrides, Type[]? extraTypes, System.Xml.Serialization.XmlRootAttribute? root, string? defaultNamespace, string? location);

C#

public XmlSerializer (Type type, System.Xml.Serialization.XmlAttributeOverrides overrides, Type[] extraTypes, System.Xml.Serialization.XmlRootAttribute root, string defaultNamespace, string location);

Paramètres

type

Type

Type de l'objet que XmlSerializer peut sérialiser.

overrides

XmlAttributeOverrides

XmlAttributeOverrides qui étend ou substitue le comportement de la classe spécifiée par le paramètre type.

extraTypes

Type[]

Tableau Type de types d'objets supplémentaires à sérialiser.

root

XmlRootAttribute

XmlRootAttribute qui définit les propriétés de l'élément racine XML.

defaultNamespace

String

Espace de noms par défaut de tous les éléments XML dans le document XML.

location

String

Emplacement des types.

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String, Evidence)

Attention

This method is obsolete and will be removed in a future release of the .NET Framework. Please use a XmlSerializer constructor overload which does not take an Evidence parameter. See http://go2.microsoft.com/fwlink/?LinkId=131738 for more information.

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Cette surcharge vous permet de fournir d'autres types qui peuvent être rencontrés pendant une sérialisation ou une désérialisation, ainsi qu'un espace de noms par défaut pour tous les éléments XML, la classe à utiliser comme élément racine XML, son emplacement et les informations d'identification requises pour y accéder.

C#

public XmlSerializer (Type type, System.Xml.Serialization.XmlAttributeOverrides overrides, Type[] extraTypes, System.Xml.Serialization.XmlRootAttribute root, string defaultNamespace, string location, System.Security.Policy.Evidence evidence);

C#

[System.Obsolete("This method is obsolete and will be removed in a future release of the .NET Framework. Please use a XmlSerializer constructor overload which does not take an Evidence parameter. See http://go2.microsoft.com/fwlink/?LinkId=131738 for more information.")]
public XmlSerializer (Type type, System.Xml.Serialization.XmlAttributeOverrides overrides, Type[] extraTypes, System.Xml.Serialization.XmlRootAttribute root, string defaultNamespace, string location, System.Security.Policy.Evidence evidence);

Paramètres

type

Type

Type de l'objet que XmlSerializer peut sérialiser.

overrides

XmlAttributeOverrides

XmlAttributeOverrides qui étend ou substitue le comportement de la classe spécifiée par le paramètre type.

extraTypes

Type[]

Tableau Type de types d'objets supplémentaires à sérialiser.

root

XmlRootAttribute

XmlRootAttribute qui définit les propriétés de l'élément racine XML.

defaultNamespace

String

Espace de noms par défaut de tous les éléments XML dans le document XML.

location

String

Emplacement des types.

evidence

Evidence

Instance de la classe Evidence qui contient des informations d'identification pour accéder aux types.

Attributs

ObsoleteAttribute

Remarques

Permet un contrôle plus précis sur l’accès à un répertoire temporaire et empêche l’injection de code et l’exploitation. Pour utiliser cette méthode, spécifiez un emplacement et donnez l’accès uniquement aux utilisateurs spécifiques. Les administrateurs peuvent configurer des stratégies avec des listes de preuves qui correspondent aux preuves des autorisations.