Specifies that the public member value be serialized by the XmlSerializer as an encoded SOAP XML element.
Assembly: System.Xml (in System.Xml.dll)
Thetype exposes the following members.
|DataType||Gets or sets the XML Schema definition language (XSD) data type of the generated XML element.|
|ElementName||Gets or sets the name of the generated XML element.|
|IsNullable||Gets or sets a value that indicates whether the XmlSerializer must serialize a member that has the xsi:null attribute set to "1".|
|TypeId||When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)|
|Equals||Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)|
|Finalize||Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)|
|GetHashCode||Returns the hash code for this instance. (Inherited from Attribute.)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|IsDefaultAttribute||When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)|
|Match||When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)|
|MemberwiseClone||Creates a shallow copy of the current Object. (Inherited from Object.)|
|ToString||Returns a string that represents the current object. (Inherited from Object.)|
|_Attribute.GetIDsOfNames||Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)|
|_Attribute.GetTypeInfo||Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)|
|_Attribute.GetTypeInfoCount||Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)|
|_Attribute.Invoke||Provides access to properties and methods exposed by an object. (Inherited from Attribute.)|
The class belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object as encoded SOAP XML. The resulting XML conforms to section 5 of the World Wide Web Consortium (www.w3.org) document, "Simple Object Access Protocol (SOAP) 1.1". For a complete list of similar attributes, see Attributes That Control Encoded SOAP Serialization.
Apply the to a public field to direct the XmlSerializer to serialize the field as an encoded SOAP XML element.
For more information about using attributes, see Extending Metadata Using Attributes.
The following example serializes an instance of a class named Transportation that contains a field named Vehicle. A is applied to the field. When the field is serialized, the XML element name is "Wheels" instead of "Vehicle". The SerializeOverride method creates a and sets the SoapElement property of a SoapAttributes to the . The SoapAttributes is added to a SoapAttributeOverrides that is used to create an XmlTypeMapping. An XmlSerializer is constructed with the XmlTypeMapping, and an instance of the Transportation class is again serialized. Because the is used to override the serialization, the generated XML element name is now "Truck" instead of "Wheels".
Imports System Imports System.IO Imports System.Xml.Serialization Imports System.Collections Imports System.Xml Imports System.Text Public Class Transportation ' The SoapElementAttribute specifies that the ' generated XML element name will be "Wheels" ' instead of "Vehicle". <SoapElement("Wheels")> Public Vehicle As String <SoapElement(DataType:= "dateTime")> _ public CreationDate As DateTime <SoapElement(IsNullable:= true)> _ public thing As Thing End Class Public Class Thing <SoapElement(IsNullable:=true)> public ThingName As string End Class Public Class Test Shared Sub Main() Dim t As Test = New Test() t.SerializeObject("SoapElementOriginalVb.xml") t.SerializeOverride("SoapElementOverrideVb.xml") Console.WriteLine("Finished writing two XML files.") End Sub ' Return an XmlSerializer used for overriding. Public Function CreateSoapOverrider() As XmlSerializer ' Create the SoapAttributes and SoapAttributeOverrides objects. Dim soapAttrs As SoapAttributes = New SoapAttributes() Dim soapOverrides As SoapAttributeOverrides = _ New SoapAttributeOverrides() ' Create a SoapElementAttribute to override ' the Vehicles property. Dim soapElement1 As SoapElementAttribute = _ 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(GetType(Transportation), "Vehicle", soapAttrs) ' Create the XmlSerializer, and return it. Dim myTypeMapping As XmlTypeMapping = (New _ SoapReflectionImporter (soapOverrides)).ImportTypeMapping _ (GetType(Transportation)) return New XmlSerializer(myTypeMapping) End Function Public Sub SerializeOverride(filename As String) ' Create an XmlSerializer instance. Dim ser As XmlSerializer = CreateSoapOverrider() ' Create the object and serialize it. Dim myTransportation As Transportation = _ New Transportation() myTransportation.Vehicle = "MyCar" myTransportation.CreationDate = DateTime.Now myTransportation.thing= new Thing() Dim writer As XmlTextWriter = _ New XmlTextWriter(filename, Encoding.UTF8) writer.Formatting = Formatting.Indented writer.WriteStartElement("wrapper") ser.Serialize(writer, myTransportation) writer.WriteEndElement() writer.Close() End Sub Public Sub SerializeObject(filename As String) ' Create an XmlSerializer instance. Dim ser As XmlSerializer = _ New XmlSerializer(GetType(Transportation)) Dim myTransportation As Transportation = _ New Transportation() myTransportation.Vehicle = "MyCar" myTransportation.CreationDate=DateTime.Now myTransportation.thing= new Thing() Dim writer As XmlTextWriter = _ new XmlTextWriter(filename, Encoding.UTF8) writer.Formatting = Formatting.Indented writer.WriteStartElement("wrapper") ser.Serialize(writer, myTransportation) writer.WriteEndElement() writer.Close() End Sub End Class
Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.