SoapAttributeOverrides Class
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)
| Name | Description | |
|---|---|---|
![]() | SoapAttributeOverrides() | Initializes a new instance of the SoapAttributeOverrides class. |
| Name | Description | |
|---|---|---|
![]() | Item[Type^] | Gets the object associated with the specified (base class) type. |
![]() | Item[Type^, String^] | Gets the object associated with the specified (base class) type. The member parameter specifies the base class member that is overridden. |
| Name | Description | |
|---|---|---|
![]() | 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 SoapAttributeOverrides. 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 the default hash function. (Inherited from Object.) |
![]() | GetType() | |
![]() | MemberwiseClone() | |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
The SoapAttributeOverrides 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 SoapAttributeOverrides, 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 SoapAttributeOverrides to override attributes that control how objects are serialized. To accomplish this, the SoapAttributeOverrides 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 SoapAttributeOverrides 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 SoapAttributeOverrides.
Add the SoapAttributes to the SoapAttributeOverrides 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.
Create an XmlTypeMapping using the ImportTypeMapping method of the SoapReflectionImporter class.
When constructing the XmlSerializer, pass the XmlTypeMapping to the XmlSerializer constructor.
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 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.
#using <System.Xml.dll> #using <System.dll> using namespace System; using namespace System::IO; using namespace System::Text; using namespace System::Xml; using namespace System::Xml::Serialization; using namespace System::Xml::Schema; ref class Car; // SoapInclude allows Vehicle to accept Car type. [SoapInclude(Car::typeid)] public ref class Vehicle abstract { public: String^ licenseNumber; DateTime makeDate; }; public ref class Car: public Vehicle{}; public enum class GroupType { // These enums can be overridden. [SoapEnum("Small")] A, [SoapEnum("Large")] B }; public ref class Group { public: [SoapAttributeAttribute(Namespace="http://www.cpandl.com")] String^ GroupName; [SoapAttributeAttribute(DataType="base64Binary")] array<Byte>^GroupNumber; [SoapAttributeAttribute(DataType="date",AttributeName="CreationDate")] DateTime Today; [SoapElement(DataType="nonNegativeInteger",ElementName="PosInt")] String^ PostitiveInt; // This is ignored when serialized unless it's overridden. [SoapIgnore] bool IgnoreThis; GroupType Grouptype; Vehicle^ MyVehicle; // The SoapInclude allows the method to return a Car. [SoapInclude(Car::typeid)] Vehicle^ myCar( String^ licNumber ) { Vehicle^ v; if ( licNumber->Equals( "" ) ) { v = gcnew Car; v->licenseNumber = "!!!!!!"; } else { v = gcnew Car; v->licenseNumber = licNumber; } return v; } }; public ref class Run { public: static void main() { Run^ test = gcnew Run; test->SerializeOriginal( "SoapOriginal.xml" ); test->SerializeOverride( "SoapOverrides.xml" ); test->DeserializeOriginal( "SoapOriginal.xml" ); test->DeserializeOverride( "SoapOverrides.xml" ); } void SerializeOriginal( String^ filename ) { // Create an instance of the XmlSerializer class. XmlTypeMapping^ myMapping = (gcnew SoapReflectionImporter)->ImportTypeMapping( Group::typeid ); XmlSerializer^ mySerializer = gcnew XmlSerializer( myMapping ); Group^ myGroup = MakeGroup(); // Writing the file requires a TextWriter. XmlTextWriter^ writer = gcnew 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(); } 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 = gcnew 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 = gcnew Group; // Set the object properties. myGroup->GroupName = ".NET"; array<Byte>^hexByte = {Convert::ToByte( 100 ),Convert::ToByte( 50 )}; myGroup->GroupNumber = hexByte; DateTime myDate = DateTime(2002,5,2); myGroup->Today = myDate; myGroup->PostitiveInt = "10000"; myGroup->IgnoreThis = true; myGroup->Grouptype = GroupType::B; Car^ thisCar = dynamic_cast<Car^>(myGroup->myCar( "1234566" )); myGroup->MyVehicle = thisCar; return myGroup; } public: void DeserializeOriginal( String^ filename ) { // Create an instance of the XmlSerializer class. XmlTypeMapping^ myMapping = (gcnew SoapReflectionImporter)->ImportTypeMapping( Group::typeid ); XmlSerializer^ mySerializer = gcnew XmlSerializer( myMapping ); // Reading the file requires an XmlTextReader. XmlTextReader^ reader = gcnew XmlTextReader( filename ); reader->ReadStartElement( "wrapper" ); // Deserialize and cast the object. Group^ myGroup; myGroup = dynamic_cast<Group^>(mySerializer->Deserialize( reader )); reader->ReadEndElement(); reader->Close(); } void DeserializeOverride( String^ filename ) { // Create an instance of the XmlSerializer class. XmlSerializer^ overRideSerializer = CreateOverrideSerializer(); // Reading the file requires an XmlTextReader. XmlTextReader^ reader = gcnew XmlTextReader( filename ); reader->ReadStartElement( "wrapper" ); // Deserialize and cast the object. Group^ myGroup; myGroup = dynamic_cast<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(); } XmlSerializer^ CreateOverrideSerializer() { SoapAttributeOverrides^ mySoapAttributeOverrides = gcnew SoapAttributeOverrides; SoapAttributes^ soapAtts = gcnew SoapAttributes; SoapElementAttribute^ mySoapElement = gcnew SoapElementAttribute; mySoapElement->ElementName = "xxxx"; soapAtts->SoapElement = mySoapElement; mySoapAttributeOverrides->Add( Group::typeid, "PostitiveInt", soapAtts ); // Override the IgnoreThis property. SoapIgnoreAttribute^ myIgnore = gcnew SoapIgnoreAttribute; soapAtts = gcnew SoapAttributes; soapAtts->SoapIgnore = false; mySoapAttributeOverrides->Add( Group::typeid, "IgnoreThis", soapAtts ); // Override the GroupType enumeration. soapAtts = gcnew SoapAttributes; SoapEnumAttribute^ xSoapEnum = gcnew SoapEnumAttribute; xSoapEnum->Name = "Over1000"; soapAtts->GroupType::SoapEnum = xSoapEnum; // Add the SoapAttributes to the // mySoapAttributeOverridesrides object. mySoapAttributeOverrides->Add( GroupType::typeid, "A", soapAtts ); // Create second enumeration and add it. soapAtts = gcnew SoapAttributes; xSoapEnum = gcnew SoapEnumAttribute; xSoapEnum->Name = "ZeroTo1000"; soapAtts->GroupType::SoapEnum = xSoapEnum; mySoapAttributeOverrides->Add( GroupType::typeid, "B", soapAtts ); // Override the Group type. soapAtts = gcnew SoapAttributes; SoapTypeAttribute^ soapType = gcnew SoapTypeAttribute; soapType->TypeName = "Team"; soapAtts->SoapType = soapType; mySoapAttributeOverrides->Add( Group::typeid, soapAtts ); // Create an XmlTypeMapping that is used to create an instance // of the XmlSerializer. Then return the XmlSerializer object. XmlTypeMapping^ myMapping = (gcnew SoapReflectionImporter( mySoapAttributeOverrides ))->ImportTypeMapping( Group::typeid ); XmlSerializer^ ser = gcnew XmlSerializer( myMapping ); return ser; } }; int main() { Run::main(); }
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.


