SoapAttributeOverrides Klasse

Definition

Namespace:

System.Xml.Serialization

Assembly:

System.Xml.XmlSerializer.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Ermöglicht das Überschreiben von Attributen, die auf Eigenschaften, Felder und Klassen beim Serialisieren oder Deserialisieren eines Objekts als codiertes SOAP durch einen XmlSerializer angewendet werden.

C#

public class SoapAttributeOverrides

Vererbung

Object

SoapAttributeOverrides

Beispiele

Im folgenden Beispiel wird eine Klasse mit dem Namen Group"." serialisiert. Die Serialisierung der GroupName IgnoreThis Felder und elemente der GroupType Enumeration wird außer Kraft gesetzt. In der CreateOverrideSerializer Methode wird eine erstellt, und für jedes überschriebene Element oder eine Aufzählung wird eine SoapAttributeOverrides SoapAttributes mit dem entsprechenden Eigenschaftssatz erstellt und dem hinzugefügt SoapAttributeOverrides. Eine XmlTypeMapping wird mithilfe des SoapAttributeOverridesKontrollkästchens erstellt, und das XmlTypeMapping wird verwendet, um die XmlSerializer Standard serialisierung außer Kraft zu setzen.

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

Die SoapAttributeOverrides Klasse ermöglicht es, XmlSerializer die Standardweise der Serialisierung einer Gruppe von Objekten außer Kraft zu setzen. Die Außerkraftsetzung der Serialisierung hat zwei Verwendungen: Zunächst können Sie die Serialisierung von Objekten steuern und erweitern, die in einer DLL gefunden wurden, auch wenn Sie keinen Zugriff auf die Quelle haben; Zweitens können Sie einen Satz serialisierbarer Klassen erstellen, aber die Objekte auf mehrere Arten serialisieren. Anstelle der Serialisierung von Elementen einer Klasseninstanz als XML-Elemente können Sie sie beispielsweise als XML-Attribute serialisieren, wodurch ein effizienteres Dokument zum Transport ermöglicht wird.

Nachdem Sie ein SoapAttributeOverridesObjekt erstellt haben, erstellen Sie eine XmlTypeMapping Mithilfe der ImportTypeMapping Methode der SoapReflectionImporter Klasse. Übergeben Sie das resultierende Objekt als Argument an den XmlSerializer Konstruktor. Das Ergebnis XmlSerializer verwendet die Daten, die von den SoapAttributeOverrides Attributen überschrieben werden, die steuern, wie Objekte serialisiert werden. Dazu enthält die SoapAttributeOverrides Auflistung der Objekttypen, die außer Kraft gesetzt werden, sowie eine SoapAttributes zugeordnete Auflistung jedes überschriebenen Objekttyps. Jeder SoapAttributes enthält einen entsprechenden Satz von Attributobjekten, die steuern, wie jedes Feld, die Eigenschaft oder klasse serialisiert wird.

Der Prozess zum Erstellen und Verwenden einer SoapAttributeOverrides Datei ist wie folgt:

1. Erstellen Sie eine SoapAttributes.

2. Erstellen Sie ein Attributobjekt, das für das Überschreiben des Objekts geeignet ist. Um z. B. ein Feld oder eine Eigenschaft außer Kraft zu setzen, erstellen Sie einen SoapElementAttribute, mithilfe des neuen, abgeleiteten Typs. Sie können optional einen neuen ElementName Zuweisen, der den Attributnamen oder Namespace der Basisklasse außer Kraft setzt.

3. Fügen Sie das Attributobjekt zur entsprechenden SoapAttributes Eigenschaft oder Auflistung hinzu. Sie würden beispielsweise die SoapElement Eigenschaft des SoapAttributes Objekts auf das SoapElementAttribute Objekt festlegen und den Membernamen angeben, der überschrieben wird.

4. Erstellen Sie eine SoapAttributeOverrides.

5. SoapAttributes Fügen Sie die Verwendung der SoapAttributeOverrides Add Methode hinzu. Wenn das Objekt überschrieben wird SoapTypeAttribute, müssen Sie nur den Typ des überschriebenen Objekts angeben. Wenn Sie jedoch ein Feld oder eine Eigenschaft außer Kraft setzen, müssen Sie auch den Namen des überschriebenen Elements angeben.

6. Erstellen Sie eine XmlTypeMapping Verwendung der ImportTypeMapping Methode der SoapReflectionImporter Klasse.

7. Übergeben Sie beim Erstellen des XmlSerializerKonstruktors den XmlTypeMapping XmlSerializer Konstruktor.

8. Verwenden Sie die resultierende XmlSerializer Verwendung, um die Klassenobjekte zu serialisieren oder zu deserialisieren.

Konstruktoren

SoapAttributeOverrides()

Initialisiert eine neue Instanz der SoapAttributeOverrides-Klasse.

Eigenschaften

Item[Type, String]	Ruft das dem angegebenen (Basisklassen-)Typ zugeordnete Objekt ab. Durch den member-Parameter wird der zu überschreibende Member der Basisklasse angegeben.
Item[Type]	Ruft das dem angegebenen (Basisklassen-)Typ zugeordnete Objekt ab.

Methoden

Add(Type, SoapAttributes)	Fügt einer Auflistung von SoapAttributes-Objekten ein SoapAttributes hinzu. Der type-Parameter gibt ein Objekt an, das von SoapAttributes überschrieben werden soll.
Add(Type, String, SoapAttributes)	Fügt der Auflistung von SoapAttributes-Objekten, die in SoapAttributes enthalten sind, ein SoapAttributeOverrides hinzu. Der type-Parameter gibt das Objekt an, das von SoapAttributes überschrieben werden soll. Der member-Parameter gibt den Namen des zu überschreibenden Members an.
Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Gilt für

Siehe auch

• XmlSerializer
• Einführung in die XML-Serialisierung
• Vorgehensweise: Serialisieren eines Objekts als einen durch SOAP codierten XML-Stream
• Attribute zur Steuerung der Serialisierung von codiertem SOAP
• Beispiele für die XML-Serialisierung