SoapEnumAttribute Class
Controls how the XmlSerializer serializes an enumeration member.
Assembly: System.Xml (in System.Xml.dll)
The SoapEnumAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
![]() ![]() | SoapEnumAttribute() | Initializes a new instance of the SoapEnumAttribute class. |
![]() ![]() | SoapEnumAttribute(String) | Initializes a new instance of the SoapEnumAttribute class using the specified element name. |
| Name | Description | |
|---|---|---|
![]() ![]() | Name | Gets or sets the value generated in an XML document when the XmlSerializer serializes an enumeration, or the value recognized when it deserializes the enumeration member. |
![]() | TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
| Name | Description | |
|---|---|---|
![]() ![]() | 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.) |
| Name | Description | |
|---|---|---|
![]() ![]() | _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 SoapEnumAttribute 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 [<topic://cpconAttributesThatControlSOAPEncodedSerialization>].
To serialize an object as an encoded SOAP message, you must construct the XmlSerializer using an XmlTypeMapping created with the ImportTypeMapping method of the SoapReflectionImporter class.
Use the SoapEnumAttribute to change the enumeration that the XmlSerializer generates or recognizes (when it serializes or deserializes a class, respectively). For example, if an enumeration contains a member named One, but you prefer that the XML output be named Single, apply the SoapEnumAttribute to the enumeration member and set the Name property to "Single".
You can override the Name property value of a SoapEnumAttribute by creating an instance of the SoapEnumAttribute class and assigning it to the SoapEnum property of a SoapAttributes. For details, see the SoapAttributeOverrides class overview.
To serialize an object as an encoded SOAP message, you must construct the XmlSerializer using an XmlTypeMapping created with the ImportTypeMapping method of the SoapReflectionImporter class.
Note |
|---|
You can use the word SoapEnum in your code instead of the longer SoapEnumAttribute. |
For more information about using attributes, see Extending Metadata Using Attributes.
The following example uses the XmlSerializer to serialize a class named Food that includes an enumeration named FoodType. The FoodType enumeration is overridden by creating a SoapEnumAttribute for each enumeration and setting the SoapEnum property of a SoapAttributes to the SoapEnumAttribute. The SoapAttributes is added to a SoapAttributeOverrides that is used to create an XmlSerializer.
#using <System.Xml.dll> #using <System.dll> using namespace System; using namespace System::IO; using namespace System::Xml; using namespace System::Xml::Serialization; public enum class GroupType { // Use the SoapEnumAttribute to instruct the XmlSerializer // to generate Small and Large instead of A and B. [SoapEnum("Small")] A, [SoapEnum("Large")] B }; public ref class Group { public: String^ GroupName; GroupType Grouptype; }; public ref class Run { public: void SerializeObject( String^ filename ) { // Create an instance of the XmlSerializer Class. XmlTypeMapping^ mapp = (gcnew SoapReflectionImporter)->ImportTypeMapping( Group::typeid ); XmlSerializer^ mySerializer = gcnew XmlSerializer( mapp ); // Writing the file requires a TextWriter. TextWriter^ writer = gcnew StreamWriter( filename ); // Create an instance of the Class that will be serialized. Group^ myGroup = gcnew Group; // Set the Object* properties. myGroup->GroupName = ".NET"; myGroup->Grouptype = GroupType::A; // Serialize the Class, and close the TextWriter. mySerializer->Serialize( writer, myGroup ); writer->Close(); } void SerializeOverride( String^ fileName ) { SoapAttributeOverrides^ soapOver = gcnew SoapAttributeOverrides; SoapAttributes^ SoapAtts = gcnew SoapAttributes; // Add a SoapEnumAttribute for the GroupType::A enumerator. // Instead of 'A' it will be S"West". SoapEnumAttribute^ soapEnum = gcnew SoapEnumAttribute( "West" ); // Override the S"A" enumerator. SoapAtts->GroupType::SoapEnum = soapEnum; soapOver->Add( GroupType::typeid, "A", SoapAtts ); // Add another SoapEnumAttribute for the GroupType::B enumerator. // Instead of //B// it will be S"East". SoapAtts = gcnew SoapAttributes; soapEnum = gcnew SoapEnumAttribute; soapEnum->Name = "East"; SoapAtts->GroupType::SoapEnum = soapEnum; soapOver->Add( GroupType::typeid, "B", SoapAtts ); // Create an XmlSerializer used for overriding. XmlTypeMapping^ map = (gcnew SoapReflectionImporter( soapOver ))->ImportTypeMapping( Group::typeid ); XmlSerializer^ ser = gcnew XmlSerializer( map ); Group^ myGroup = gcnew Group; myGroup->GroupName = ".NET"; myGroup->Grouptype = GroupType::B; // Writing the file requires a TextWriter. TextWriter^ writer = gcnew StreamWriter( fileName ); ser->Serialize( writer, myGroup ); writer->Close(); } }; int main() { Run^ test = gcnew Run; test->SerializeObject( "SoapEnum.xml" ); test->SerializeOverride( "SoapOverride.xml" ); Console::WriteLine( "Fininished writing two files" ); }
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.
