SoapAttributes Class
Represents a collection of attribute objects that control how the XmlSerializer serializes and deserializes SOAP methods.
Assembly: System.Xml (in System.Xml.dll)
| Name | Description | |
|---|---|---|
![]() | SoapAttributes() | Initializes a new instance of the SoapAttributes class. |
![]() | SoapAttributes(ICustomAttributeProvider) | Initializes a new instance of the SoapAttributes class using the specified custom type. |
| Name | Description | |
|---|---|---|
![]() | SoapAttribute | Gets or sets the SoapAttributeAttribute to override. |
![]() | SoapDefaultValue | Gets or sets the default value of an XML element or attribute. |
![]() | SoapElement | Gets or sets a SoapElementAttribute to override. |
![]() | SoapEnum | Gets or sets an object that specifies how the XmlSerializer serializes a SOAP enumeration. |
![]() | SoapIgnore | Gets or sets a value that specifies whether the XmlSerializer serializes a public field or property as encoded SOAP XML. |
![]() | SoapType | Gets or sets an object that instructs the XmlSerializer how to serialize an object type into encoded SOAP XML. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
![]() | 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() | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType() | |
![]() | MemberwiseClone() | |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
Creating a SoapAttributes is part of a process that overrides the default way the XmlSerializer serializes class instances. For example, suppose you want to serialize an object that is created from a DLL that has an inaccessible source. By using the SoapAttributeOverrides class, you can augment or otherwise control how the object is serialized.
The members of the SoapAttributes class correspond directly to a family of attribute classes that control serialization. For example, the SoapAttribute property must be set to a SoapAttributeAttribute, which allows you to override serialization of a field or property by instructing the XmlSerializer to serialize the property value as an encoded SOAP attribute. For a complete list of attributes that control encoded SOAP serialization, see Attributes That Control Encoded SOAP Serialization.
For more details about adding an instance of the SoapAttributes class to an instance of the SoapAttributeOverrides class, see the SoapAttributeOverrides class overview.
The following example serializes a class named Group. The serialization of the GroupName and IgnoreThis fields and the members of the GroupType enumeration are overridden. In the CreateOverrideSerializer method, a SoapAttributeOverrides is created, and for each overridden member or enumeration, a SoapAttributes is created with the appropriate property set and added to the SoapAttributeOverrides. An XmlTypeMapping is created using the SoapAttributeOverrides, and that XmlTypeMapping is used to create the XmlSerializer that overrides the default serialization.
Imports System Imports System.IO Imports System.Text Imports System.Xml Imports System.Xml.Serialization Imports System.Xml.Schema Public Class Group <SoapAttribute (Namespace:= "http:'www.cpandl.com")> _ Public GroupName As String <SoapAttribute(DataType:= "base64Binary")> _ Public GroupNumber() As Byte <SoapAttribute(DataType:= "date", _ AttributeName:= "CreationDate")> _ Public Today As DateTime <SoapElement(DataType:= "nonNegativeInteger", _ ElementName:= "PosInt")> _ Public PostitiveInt As String ' This is ignored when serialized unless it's overridden. <SoapIgnore> _ Public IgnoreThis As Boolean Public Grouptype As GroupType Public MyVehicle As Vehicle ' The SoapInclude allows the method to return a Car. <SoapInclude(GetType(Car))> _ Public Function myCar(licNumber As String ) As Vehicle Dim v As Vehicle if licNumber = "" Then v = New Car() v.licenseNumber = "!!!!!!" else v = New Car() v.licenseNumber = licNumber End If return v End Function End Class ' SoapInclude allows Vehicle to accept Car type. <SoapInclude(GetType(Car))> _ Public MustInherit class Vehicle Public licenseNumber As String Public makeDate As DateTime End Class Public Class Car Inherits Vehicle End Class Public enum GroupType ' These enums can be overridden. <SoapEnum("Small")> _ A <SoapEnum("Large")> _ B End Enum Public Class Run Shared Sub Main() Dim test As Run = New Run() test.SerializeOriginal("SoapOriginal.xml") test.SerializeOverride("SoapOverrides.xml") test.DeserializeOriginal("SoapOriginal.xml") test.DeserializeOverride("SoapOverrides.xml") End SUb Public Sub SerializeOriginal(filename As String) ' Create an instance of the XmlSerializer class. Dim myMapping As XmlTypeMapping = _ (New SoapReflectionImporter().ImportTypeMapping _ (GetType(Group))) Dim mySerializer As XmlSerializer = _ New XmlSerializer(myMapping) Dim myGroup As Group =MakeGroup() ' Writing the file requires a TextWriter. Dim writer As XmlTextWriter = _ 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() End Sub Public Sub SerializeOverride(filename As String) ' Create an instance of the XmlSerializer class ' that overrides the serialization. Dim overRideSerializer As XmlSerializer = _ CreateOverrideSerializer() Dim myGroup As Group =MakeGroup() ' Writing the file requires a TextWriter. Dim writer As XmlTextWriter = _ 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() End Sub private Function MakeGroup() As Group ' Create an instance of the class that will be serialized. Dim myGroup As Group = New Group() ' Set the object properties. myGroup.GroupName = ".NET" Dim hexByte()As Byte = new Byte(1){Convert.ToByte(100), _ Convert.ToByte(50)} myGroup.GroupNumber = hexByte Dim myDate As DateTime = new DateTime(2002,5,2) myGroup.Today = myDate myGroup.PostitiveInt = "10000" myGroup.IgnoreThis = true myGroup.Grouptype = GroupType.B Dim thisCar As Car thisCar =CType(myGroup.myCar("1234566"), Car) myGroup.myVehicle=thisCar return myGroup End Function Public Sub DeserializeOriginal(filename As String) ' Create an instance of the XmlSerializer class. Dim myMapping As XmlTypeMapping = _ (New SoapReflectionImporter().ImportTypeMapping _ (GetType(Group))) Dim mySerializer As XmlSerializer = _ New XmlSerializer(myMapping) ' Reading the file requires an XmlTextReader. Dim reader As XmlTextReader = _ New XmlTextReader(filename) reader.ReadStartElement("wrapper") ' Deserialize and cast the object. Dim myGroup As Group = _ CType(mySerializer.Deserialize(reader), Group) reader.ReadEndElement() reader.Close() End Sub Public Sub DeserializeOverride(filename As String) ' Create an instance of the XmlSerializer class. Dim overRideSerializer As XmlSerializer = _ CreateOverrideSerializer() ' Reading the file requires an XmlTextReader. Dim reader As XmlTextReader = _ New XmlTextReader(filename) reader.ReadStartElement("wrapper") ' Deserialize and cast the object. Dim myGroup As Group = _ CType(overRideSerializer.Deserialize(reader), Group) reader.ReadEndElement() reader.Close() ReadGroup(myGroup) End Sub private Sub ReadGroup(myGroup As Group) 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() End Sub Private Function CreateOverrideSerializer() As XmlSerializer Dim soapOver As SoapAttributeOverrides = New SoapAttributeOverrides() Dim soapAtts As SoapAttributes = New SoapAttributes() Dim mySoapElement As SoapElementAttribute = New SoapElementAttribute() mySoapElement.ElementName = "xxxx" soapAtts.SoapElement = mySoapElement soapOver.Add(GetType(Group), "PostitiveInt", soapAtts) ' Override the IgnoreThis property. Dim myIgnore As SoapIgnoreAttribute = new SoapIgnoreAttribute() soapAtts = New SoapAttributes() soapAtts.SoapIgnore = false soapOver.Add(GetType(Group), "IgnoreThis", soapAtts) ' Override the GroupType enumeration. soapAtts = New SoapAttributes() Dim xSoapEnum As SoapEnumAttribute = new SoapEnumAttribute() xSoapEnum.Name = "Over1000" soapAtts.SoapEnum = xSoapEnum ' Add the SoapAttributes to the SoapOverrides object. soapOver.Add(GetType(GroupType), "A", soapAtts) ' Create second enumeration and add it. soapAtts = New SoapAttributes() xSoapEnum = New SoapEnumAttribute() xSoapEnum.Name = "ZeroTo1000" soapAtts.SoapEnum = xSoapEnum soapOver.Add(GetType(GroupType), "B", soapAtts) ' Override the Group type. soapAtts = New SoapAttributes() Dim soapType As SoapTypeAttribute = New SoapTypeAttribute() soapType.TypeName = "Team" soapAtts.SoapType = soapType soapOver.Add(GetType(Group),soapAtts) Dim myMapping As XmlTypeMapping = (New SoapReflectionImporter( _ soapOver)).ImportTypeMapping(GetType(Group)) Dim ser As XmlSerializer = new XmlSerializer(myMapping) return ser End Function End Class
Available since 1.1
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.


