Allows you to override attributes applied to properties, fields, and classes when you use an XmlSerializer to serialize or deserialize an object as encoded SOAP.
Assembly: System.Xml (in System.Xml.dll)
Thetype exposes the following members.
|Add(Type, SoapAttributes)||Adds a SoapAttributes to a collection of SoapAttributes objects. The type parameter specifies an object to be overridden by the SoapAttributes.|
|Add(Type, String, SoapAttributes)||Adds a SoapAttributes to the collection of SoapAttributes objects contained by the . The type parameter specifies the object to be overridden by the SoapAttributes. The member parameter specifies the name of a member that is overridden.|
|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 a hash function for a particular type. (Inherited from Object.)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|MemberwiseClone||Creates a shallow copy of the current Object. (Inherited from Object.)|
|ToString||Returns a string that represents the current object. (Inherited from Object.)|
The class enables an XmlSerializer to override the default way of serializing a set of objects. Overriding serialization in this way has two uses: first, you can control and augment the serialization of objects found in a DLL, even if you do not have access to the source; second, you can create one set of serializable classes, but serialize the objects in multiple ways. For example, instead of serializing members of a class instance as XML elements, you can serialize them as XML attributes, resulting in a more efficient document to transport.
After you create a , you create an XmlTypeMapping using the ImportTypeMapping method of the SoapReflectionImporter class. Pass the resulting object as an argument to the XmlSerializer constructor. The resulting XmlSerializer uses the data contained by the to override attributes that control how objects are serialized. To accomplish this, the contains a collection of the object types that are overridden, as well as a SoapAttributes associated with each overridden object type. Each SoapAttributes contains an appropriate set of attribute objects that control how each field, property, or class is serialized.
The process for creating and using a is as follows:
Create a SoapAttributes.
Create an attribute object that is appropriate to the object being overridden. For example, to override a field or property, create a SoapElementAttribute, using the new, derived type. You can optionally assign a new ElementName that overrides the base class's attribute name or namespace.
Add the attribute object to the appropriate SoapAttributes property or collection. For example, you would set the SoapElement property of the SoapAttributes object to the SoapElementAttribute and specify the member name that is being overridden.
Create a .
Add the SoapAttributes to the using the Add method. If the object being overridden is a SoapTypeAttribute, you need only specify the type of the overridden object. But if you are overriding a field or property, you must also specify the name of the overridden member.
Use the resulting XmlSerializer to serialize or deserialize the class objects.
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 is created, and for each overridden member or enumeration, a SoapAttributes is created with the appropriate property set and added to the . An XmlTypeMapping is created using the , and that XmlTypeMapping is used to create the XmlSerializer that overrides the default serialization.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.