XmlSerializer Konstruktoren

Definition

Namespace:

System.Xml.Serialization

Assembly:

System.Xml.XmlSerializer.dll

Initialisiert eine neue Instanz der XmlSerializer-Klasse.

Überlädt

XmlSerializer()	Initialisiert eine neue Instanz der XmlSerializer-Klasse.
XmlSerializer(Type)	Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und XML-Dokumente in Objekte des angegebenen Typs deserialisieren kann.
XmlSerializer(XmlTypeMapping)	Initialisiert eine Instanz der XmlSerializer-Klasse mithilfe eines Objekts, das einen Typ einem anderen zuweist.
XmlSerializer(Type, String)	Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und XML-Dokumente in Objekte des angegebenen Typs deserialisieren kann. Gibt den Standardnamespace für alle XML-Elemente an.
XmlSerializer(Type, Type[])	Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und XML-Dokumente in ein Objekt eines angegebenen Typs deserialisieren kann. Wenn eine Eigenschaft oder ein Feld ein Array zurückgibt, werden durch den extraTypes-Parameter die Objekte angegeben, die in das Array eingefügt werden können.
XmlSerializer(Type, XmlAttributeOverrides)	Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und XML-Dokumente in Objekte des angegebenen Typs deserialisieren kann. Jedes zu serialisierende Objekt kann selbst Instanzen von Klassen enthalten, die von dieser Überladung durch andere Klassen überschrieben werden können.
XmlSerializer(Type, XmlRootAttribute)	Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und ein XML-Dokument in ein Objekt des angegebenen Typs deserialisieren kann. Außerdem wird die als XML-Stammelement zu verwendende Klasse angegeben.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String)	Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte vom Typ Object in Instanzen eines XML-Dokuments serialisieren und Instanzen eines XML-Dokuments in Objekte vom Typ Object deserialisieren kann. Jedes zu serialisierende Objekt kann selbst Instanzen von Klassen enthalten, die von dieser Überladung durch andere Klassen überschrieben werden können. Diese Überladung gibt außerdem den Standardnamespace für alle XML-Elemente sowie die als XML-Stammelement zu verwendende Klasse an.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String)	Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte vom Typ Object in Instanzen eines XML-Dokuments serialisieren und Instanzen eines XML-Dokuments in Objekte vom Typ Object deserialisieren kann. Jedes zu serialisierende Objekt kann selbst Instanzen von Klassen enthalten, die von dieser Überladung durch andere Klassen überschrieben werden können. Diese Überladung gibt außerdem den Standardnamespace für alle XML-Elemente sowie die als XML-Stammelement zu verwendende Klasse an.

XmlSerializer()

Quelle:

XmlSerializer.cs

Initialisiert eine neue Instanz der XmlSerializer-Klasse.

C#

protected XmlSerializer ();

XmlSerializer(Type)

Quelle:

XmlSerializer.cs

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und XML-Dokumente in Objekte des angegebenen Typs deserialisieren kann.

C#

public XmlSerializer (Type type);

Parameter

type

Type

Der Objekttyp, den dieser XmlSerializer serialisieren kann.

Beispiele

Im folgenden Beispiel wird ein XmlSerializer erstellt, das ein -Objekt namens Widgetserialisiert. Im Beispiel werden vor dem Aufrufen Serialize der -Methode verschiedene Eigenschaften des -Objekts festgelegt.

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

Hinweise

In der Regel definiert eine Anwendung mehrere Klassen, die in XmlSerializer ein einzelnes XML-Instanzdokument konvertiert werden. Der XmlSerializer muss jedoch nur einen Typ kennen– den Typ der Klasse, der das XML-Stammelement darstellt. Die XmlSerializer serialisiert automatisch alle untergeordneten Klasseninstanzen. Ebenso ist für die Deserialisierung nur der Typ des XML-Stammelements erforderlich.

Weitere Informationen

• Serialize(TextWriter, Object)
• Deserialize(Stream)
• XmlAttributes
• Einführung in die XML-Serialisierung
• How to: Angeben eines alternativen Elementnamens für einen XML-Stream.
• Steuern der XML-Serialisierung mit Attributen
• Beispiele für die XML-Serialisierung
• XML Schema Definition-Tool (Xsd.exe)

XmlSerializer(XmlTypeMapping)

Quelle:

XmlSerializer.cs

Initialisiert eine Instanz der XmlSerializer-Klasse mithilfe eines Objekts, das einen Typ einem anderen zuweist.

C#

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

Parameter

xmlTypeMapping

XmlTypeMapping

XmlTypeMapping zum Zuordnen eines Typs zu einem anderen.

Beispiele

Im folgenden Beispiel wird eine Klasse namens Groupserialisiert. Die Serialisierung der GroupNameFelder IgnoreThis und der Member der GroupType Enumeration wird überschrieben. In der CreateOverrideSerializer -Methode wird ein SoapAttributeOverrides -Objekt erstellt, und für jeden überschriebenen Member oder jede -Enumeration wird ein SoapAttributes -Objekt mit dem entsprechenden Eigenschaftensatz erstellt und dem SoapAttributeOverrides -Objekt hinzugefügt. Ein XmlMapping -Objekt wird mithilfe des SoapAttributeOverrides -Objekts erstellt, und dieses XmlMapping Objekt wird verwendet, um die zu erstellen, die XmlSerializer die Standardserialisierung außer Kraft setzt.

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

Hinweise

Dieser Konstruktor wird verwendet, um eine XmlSerializer zu erstellen, wenn Sie ein Objekt in eine SOAP-Nachricht serialisieren. Um die generierten SOAP-Nachrichten zu steuern, verwenden Sie die speziellen Attribute (beginnend mit dem Wort "Soap"), die System.Xml.Serialization sich im Namespace befinden.

Weitere Informationen

• XmlAttributes
• Einführung in die XML-Serialisierung
• How to: Angeben eines alternativen Elementnamens für einen XML-Stream.
• Steuern der XML-Serialisierung mit Attributen
• Beispiele für die XML-Serialisierung
• XML Schema Definition-Tool (Xsd.exe)

XmlSerializer(Type, String)

Quelle:

XmlSerializer.cs

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und XML-Dokumente in Objekte des angegebenen Typs deserialisieren kann. Gibt den Standardnamespace für alle XML-Elemente an.

C#

public XmlSerializer (Type type, string? defaultNamespace);

Parameter

type

Type

Der Objekttyp, den dieser XmlSerializer serialisieren kann.

defaultNamespace

String

Der für alle XML-Elemente zu verwendende Standardnamespace.

Beispiele

Im folgenden Beispiel wird ein XmlSerializer erstellt, das ein -Objekt namens Widgetserialisiert. Im Beispiel werden vor dem Aufrufen Serialize der -Methode verschiedene Eigenschaften des -Objekts festgelegt.

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.
}

Weitere Informationen

• XmlAttributes
• Einführung in die XML-Serialisierung
• How to: Angeben eines alternativen Elementnamens für einen XML-Stream.
• Steuern der XML-Serialisierung mit Attributen
• Beispiele für die XML-Serialisierung
• XML Schema Definition-Tool (Xsd.exe)

XmlSerializer(Type, Type[])

Quelle:

XmlSerializer.cs

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und XML-Dokumente in ein Objekt eines angegebenen Typs deserialisieren kann. Wenn eine Eigenschaft oder ein Feld ein Array zurückgibt, werden durch den extraTypes-Parameter die Objekte angegeben, die in das Array eingefügt werden können.

C#

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

Parameter

type

Type

Der Objekttyp, den dieser XmlSerializer serialisieren kann.

extraTypes

Type[]

Ein Type-Array mit zusätzlich zu serialisierenden Objekttypen.

Beispiele

Im folgenden Beispiel wird eine Instanz einer Klasse serialisiert, die ein öffentliches Feld enthält, das ein Array von -Objekten zurückgibt. Der extraTypes Parameter des XmlSerializer Konstruktors gibt die Typen der Objekte an, die im Array serialisiert werden können.

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

Hinweise

Wenn eine öffentliche Eigenschaft oder ein öffentliches Feld ein Objekt oder ein Array von Objekten zurückgibt, werden die Objekttypen standardmäßig automatisch serialisiert. Wenn eine Klasse jedoch ein Feld oder eine Eigenschaft enthält, die ein Array vom Typ Objectzurückgibt, kann jedes Objekt in dieses Array eingefügt werden. In diesem Fall muss angewiesen XmlSerializer werden, alle möglichen Objekttypen zu erwarten, die in das Object Array eingefügt werden. Verwenden Sie dazu den extraTypes Parameter, um die zusätzlichen Objekttypen anzugeben, die serialisiert oder deserialisiert werden sollen.

Sie können den -Parameter auch verwenden, um typen anzugeben, die extraTypes von einer Basisklasse abgeleitet sind. Angenommen, eine Basisklasse mit dem Namen Phone exists, und eine Klasse namens InternationalPhone wird von ihr abgeleitet. Verwenden Sie den extraTypes -Parameter, um auch den abgeleiteten Typ anzugeben.

Weitere Informationen

• XmlAttributes
• Einführung in die XML-Serialisierung
• How to: Angeben eines alternativen Elementnamens für einen XML-Stream.
• Steuern der XML-Serialisierung mit Attributen
• Beispiele für die XML-Serialisierung
• XML Schema Definition-Tool (Xsd.exe)

XmlSerializer(Type, XmlAttributeOverrides)

Quelle:

XmlSerializer.cs

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und XML-Dokumente in Objekte des angegebenen Typs deserialisieren kann. Jedes zu serialisierende Objekt kann selbst Instanzen von Klassen enthalten, die von dieser Überladung durch andere Klassen überschrieben werden können.

C#

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

Parameter

type

Type

Der Typ des zu serialisierenden Objekts.

overrides

XmlAttributeOverrides

XmlAttributeOverrides.

Beispiele

Im folgenden Beispiel wird eine Instanz einer Klasse serialisiert, die in einer DLL definiert ist, und zu diesem Fall werden die in der DLL gefundenen öffentlichen Member überschrieben.

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

Hinweise

Der overrides Parameter kann verwendet werden, um zu steuern, wie Felder und Eigenschaften in XML codiert werden. Diese Einstellungen überschreiben alle Attribute, die bereits für die -Objekte vorhanden sind. Dies kann nützlich sein, wenn der Quellcode nicht geändert werden kann oder mehrere Codierungen für dieselben Klassen erforderlich sind.

Weitere Informationen

• XmlAttributeOverrides
• XmlAttributes
• Einführung in die XML-Serialisierung
• How to: Angeben eines alternativen Elementnamens für einen XML-Stream.
• Steuern der XML-Serialisierung mit Attributen
• Beispiele für die XML-Serialisierung
• XML Schema Definition-Tool (Xsd.exe)

XmlSerializer(Type, XmlRootAttribute)

Quelle:

XmlSerializer.cs

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und ein XML-Dokument in ein Objekt des angegebenen Typs deserialisieren kann. Außerdem wird die als XML-Stammelement zu verwendende Klasse angegeben.

C#

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

Parameter

type

Type

Der Objekttyp, den dieser XmlSerializer serialisieren kann.

root

XmlRootAttribute

Ein XmlRootAttribute, das das XML-Stammelement darstellt.

Beispiele

Im folgenden Beispiel wird ein XmlSerializer erstellt, das ein XmlRootAttribute verwendet, das verschiedene Eigenschaften des XML-Stammelements enthält, z. B. seinen Namespace und den Elementnamen.

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.
}

Hinweise

Das Stammelement eines XML-Dokuments umfasst alle anderen Elemente. Standardmäßig wird das durch den type Parameter angegebene Objekt als Stammelement serialisiert. Eigenschaften, z. B. der XML-Elementname des Stammelements, werden dem type -Objekt entnommen. Mit dem root Parameter können Sie jedoch die Informationen des Standardobjekts ersetzen, indem Sie ein XmlRootAttributeangeben. Mit dem -Objekt können Sie einen anderen Namespace, einen anderen Elementnamen usw. festlegen.

Weitere Informationen

• XmlAttributes
• Einführung in die XML-Serialisierung
• How to: Angeben eines alternativen Elementnamens für einen XML-Stream.
• Steuern der XML-Serialisierung mit Attributen
• Beispiele für die XML-Serialisierung
• XML Schema Definition-Tool (Xsd.exe)

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

Quelle:

XmlSerializer.cs

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte vom Typ Object in Instanzen eines XML-Dokuments serialisieren und Instanzen eines XML-Dokuments in Objekte vom Typ Object deserialisieren kann. Jedes zu serialisierende Objekt kann selbst Instanzen von Klassen enthalten, die von dieser Überladung durch andere Klassen überschrieben werden können. Diese Überladung gibt außerdem den Standardnamespace für alle XML-Elemente sowie die als XML-Stammelement zu verwendende Klasse an.

C#

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

Parameter

type

Type

Der Objekttyp, den dieser XmlSerializer serialisieren kann.

overrides

XmlAttributeOverrides

Ein XmlAttributeOverrides, das das Verhalten der im type-Parameter festgelegten Klasse erweitert oder überschreibt.

extraTypes

Type[]

Ein Type-Array mit zusätzlich zu serialisierenden Objekttypen.

root

XmlRootAttribute

Ein XmlRootAttribute, das die Eigenschaften des XML-Stammelements definiert.

defaultNamespace

String

Der Standardnamespace aller XML-Elemente im XML-Dokument.

Beispiele

Im folgenden Beispiel wird eine Instanz einer Klasse serialisiert, die in einer DLL definiert ist, und dazu werden die in der -Klasse gefundenen öffentlichen Member überschrieben. Das Beispiel gibt auch ein Array von zusätzlichen Typen, den Standardnamespace für alle XML-Elemente und die zu verwendende Klasse an, die die XML-Stammelementinformationen bereitstellt. Im Beispiel wird davon ausgegangen, dass der Code am Anfang in eine DLL mit dem Namen HighSchoolkompiliert wurde.

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

Hinweise

Der overrides -Parameter ermöglicht die Erstellung eines XmlSerializer , das eine Klasse serialisiert, die das Verhalten einer Basisklasse erweitert oder außer Kraft setzt. Bei einer DLL ist es beispielsweise möglich, eine Klasse zu erstellen, die eine in der DLL enthaltene Klasse erbt oder erweitert. Um eine solche Klasse zu serialisieren, müssen Sie beim Erstellen von eine XmlSerializerInstanz der XmlAttributeOverrides -Klasse verwenden. Weitere Details finden Sie unter XmlAttributeOverrides.

Wenn eine öffentliche Eigenschaft oder ein öffentliches Feld ein Objekt oder ein Array von Objekten zurückgibt, werden die Objekttypen automatisch serialisiert. Wenn eine Klasse jedoch ein Feld oder eine Eigenschaft enthält, die ein Array vom Typ Objectzurückgibt, kann jedes Objekt in dieses Array eingefügt werden. In diesem Fall muss der XmlSerializer angewiesen werden, alle möglichen Objekttypen zu erwarten, die in das Object Array eingefügt werden. Verwenden Sie dazu den extraTypes Parameter, um die zusätzlichen Objekttypen anzugeben, die serialisiert oder deserialisiert werden sollen.

Das Stammelement eines XML-Dokuments umfasst alle anderen Elemente. Standardmäßig wird das durch den type Parameter angegebene Objekt als Stammelement serialisiert. Eigenschaften, z. B. der XML-Elementname des Stammelements, werden dem type -Objekt entnommen. Mit dem root Parameter können Sie jedoch die Informationen des Standardobjekts ersetzen, indem Sie ein XmlRootAttributeangeben. Mit dem -Objekt können Sie einen anderen Namespace, einen anderen Elementnamen usw. festlegen.

Verwenden Sie den defaultName -Parameter, um den Standardnamespace aller XML-Elemente anzugeben, die XmlSerializervon generiert werden.

Weitere Informationen

• XmlAttributeOverrides
• XmlRootAttribute
• XmlAttributes
• Einführung in die XML-Serialisierung
• How to: Angeben eines alternativen Elementnamens für einen XML-Stream.
• Steuern der XML-Serialisierung mit Attributen
• Beispiele für die XML-Serialisierung
• XML Schema Definition-Tool (Xsd.exe)

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

Quelle:

XmlSerializer.cs

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte vom Typ Object in Instanzen eines XML-Dokuments serialisieren und Instanzen eines XML-Dokuments in Objekte vom Typ Object deserialisieren kann. Jedes zu serialisierende Objekt kann selbst Instanzen von Klassen enthalten, die von dieser Überladung durch andere Klassen überschrieben werden können. Diese Überladung gibt außerdem den Standardnamespace für alle XML-Elemente sowie die als XML-Stammelement zu verwendende Klasse an.

C#

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

Parameter

type

Type

Der Objekttyp, den dieser XmlSerializer serialisieren kann.

overrides

XmlAttributeOverrides

Ein XmlAttributeOverrides, das das Verhalten der im type-Parameter festgelegten Klasse erweitert oder überschreibt.

extraTypes

Type[]

Ein Type-Array mit zusätzlich zu serialisierenden Objekttypen.

root

XmlRootAttribute

Ein XmlRootAttribute, das die Eigenschaften des XML-Stammelements definiert.

defaultNamespace

String

Der Standardnamespace aller XML-Elemente im XML-Dokument.

location

String

Der Speicherort der Typen.