SoapElementAttribute Klasse

Definition

Namespace:

System.Xml.Serialization

Assembly:

System.Xml.XmlSerializer.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Gibt an, dass XmlSerializer den öffentlichen Memberwert als codiertes SOAP XML-Element serialisieren soll.

C#

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
public class SoapElementAttribute : Attribute

Vererbung

Object

Attribute

SoapElementAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird eine Instanz einer Klasse mit dem Namen Transportation eines Felds mit dem Namen Vehicleserialisiert. A SoapElementAttribute wird auf das Feld angewendet. Wenn das Feld serialisiert wird, lautet der XML-Elementname "Wheels" anstelle von "Vehicle". Die SerializeOverride Methode erstellt eine SoapElementAttribute und legt die SoapElement Eigenschaft einer SoapAttributes auf der SoapElementAttribute. Dies SoapAttributes wird zu einer SoapAttributeOverrides hinzugefügt, die zum Erstellen eines XmlTypeMapping. Eine XmlSerializer wird mit dem XmlTypeMapping, und eine Instanz der Transportation Klasse wird erneut serialisiert. Da die SoapElementAttribute Serialisierung überschreiben wird, lautet der generierte XML-Elementname jetzt "Truck" anstelle von "Wheels".

C#

using System;
using System.IO;
using System.Xml.Serialization;
using System.Collections;
using System.Xml;
using System.Text;
public class Transportation
{
   // The SoapElementAttribute specifies that the
   // generated XML element name will be "Wheels"
   // instead of "Vehicle".
   [SoapElement("Wheels")]
   public string Vehicle;
   [SoapElement(DataType = "dateTime")]
   public DateTime CreationDate;
   [SoapElement(IsNullable = true)]
   public Thing thing;
}

public class Thing{
   [SoapElement(IsNullable=true)] public string ThingName;
}

public class Test
{
   public static void Main()
   {
      Test t = new Test();
      t.SerializeObject("SoapElementOriginal.xml");
      t.SerializeOverride("SoapElementOverride.xml");
      Console.WriteLine("Finished writing two XML files.");
   }

   // Return an XmlSerializer used for overriding.
   public XmlSerializer CreateSoapOverrider()
   {
      // Create the SoapAttributes and SoapAttributeOverrides objects.
      SoapAttributes soapAttrs = new SoapAttributes();

      SoapAttributeOverrides soapOverrides =
      new SoapAttributeOverrides();

      /* Create an SoapElementAttribute to override
      the Vehicles property. */
      SoapElementAttribute soapElement1 =
      new SoapElementAttribute("Truck");
      // Set the SoapElement to the object.
      soapAttrs.SoapElement= soapElement1;

      /* Add the SoapAttributes to the SoapAttributeOverrides,
      specifying the member to override. */
      soapOverrides.Add(typeof(Transportation), "Vehicle", soapAttrs);

      // Create the XmlSerializer, and return it.
      XmlTypeMapping myTypeMapping = (new SoapReflectionImporter
      (soapOverrides)).ImportTypeMapping(typeof(Transportation));
      return new XmlSerializer(myTypeMapping);
   }

   public void SerializeOverride(string filename)
   {
      // Create an XmlSerializer instance.
      XmlSerializer ser = CreateSoapOverrider();

      // Create the object and serialize it.
      Transportation myTransportation =
      new Transportation();

      myTransportation.Vehicle = "MyCar";
      myTransportation.CreationDate=DateTime.Now;
      myTransportation.thing = new Thing();

      XmlTextWriter writer =
      new XmlTextWriter(filename, Encoding.UTF8);
      writer.Formatting = Formatting.Indented;
      writer.WriteStartElement("wrapper");
      ser.Serialize(writer, myTransportation);
      writer.WriteEndElement();
      writer.Close();
   }
   public void SerializeObject(string filename){
      // Create an XmlSerializer instance.
      XmlSerializer ser = new XmlSerializer(typeof(Transportation));
      Transportation myTransportation =
      new Transportation();
      myTransportation.Vehicle = "MyCar";
      myTransportation.CreationDate = DateTime.Now;
      myTransportation.thing = new Thing();
      XmlTextWriter writer =
      new XmlTextWriter(filename, Encoding.UTF8);
      writer.Formatting = Formatting.Indented;
      writer.WriteStartElement("wrapper");
      ser.Serialize(writer, myTransportation);
      writer.WriteEndElement();
      writer.Close();
   }
}

Hinweise

Die SoapElementAttribute Klasse gehört zu einer Familie von Attributen, die steuert, wie das XmlSerializer Serialisieren oder Deserialisieren eines Objekts als codierte SOAP-XML-Code. Der resultierende XML-Code entspricht Abschnitt 5 des World Wide Web Consortium-Dokuments, Simple Object Access Protocol (SOAP) 1.1. Eine vollständige Liste ähnlicher Attribute finden Sie unter Attribute, die codierte SOAP-Serialisierung steuern.

Um ein Objekt als codierte SOAP-Nachricht serialisieren zu können, müssen Sie die XmlSerializer Verwendung einer XmlTypeMapping mit der ImportTypeMapping Methode der SoapReflectionImporter Klasse erstellten Erstellen.

Wenden Sie das SoapElementAttribute Feld auf ein öffentliches Feld an, um das XmlSerializer Feld als codiertes SOAP-XML-Element zu serialisieren.

Weitere Informationen zur Verwendung von Attributen finden Sie unter Attribute.

Konstruktoren

SoapElementAttribute()	Initialisiert eine neue Instanz der SoapElementAttribute-Klasse.
SoapElementAttribute(String)	Initialisiert eine neue Instanz der SoapElementAttribute-Klasse und gibt den Namen des XML-Elements an.

Eigenschaften

DataType	Ruft den XSD-Datentyp (XML Schema Definition) des generierten XML-Elements ab oder legt diesen fest.
ElementName	Ruft den Namen des generierten XML-Elements ab oder legt diesen fest.
IsNullable	Ruft einen Wert ab oder legt diesen fest, der angibt, ob der XmlSerializer einen Member, dessen xsi:null-Attribut auf "1" festgelegt ist, serialisieren muss.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
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)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu. (Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können. (Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1). (Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit. (Geerbt von Attribute)

Gilt für