Export (0) Print
Expand All

SoapEnumAttribute Class

Controls how the XmlSerializer serializes an enumeration member.

Namespace: System.Xml.Serialization
Assembly: System.Xml (in system.xml.dll)

[AttributeUsageAttribute(AttributeTargets.Field)] 
public class SoapEnumAttribute : Attribute
/** @attribute AttributeUsageAttribute(AttributeTargets.Field) */ 
public class SoapEnumAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.Field) 
public class SoapEnumAttribute extends 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 Attributes That Control Encoded SOAP Serialization.

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.

NoteNote

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;
using System.IO;
using System.Xml;
using System.Xml.Serialization;

public class Group{
   public string GroupName;
   public GroupType Grouptype;
}

public enum 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 class Run {
   static void Main(){
      Run test= new Run();
      test.SerializeObject("SoapEnum.xml");
      test.SerializeOverride("SoapOverride.xml");
      Console.WriteLine("Fininished writing two files");
   }

     private void SerializeObject(string filename){
      // Create an instance of the XmlSerializer Class.
      XmlTypeMapping mapp  =
      (new SoapReflectionImporter()).ImportTypeMapping(typeof(Group));
      XmlSerializer mySerializer =  new XmlSerializer(mapp);

      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Create an instance of the Class that will be serialized.
      Group myGroup = new 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();
   }

   private void SerializeOverride(string fileName){
      SoapAttributeOverrides soapOver = new SoapAttributeOverrides();
      SoapAttributes SoapAtts = new SoapAttributes();

      // Add a SoapEnumAttribute for the GroupType.A enumerator.       
      // Instead of 'A'  it will be "West".
      SoapEnumAttribute soapEnum = new SoapEnumAttribute("West");
      // Override the "A" enumerator.
      SoapAtts.SoapEnum = soapEnum;
      soapOver.Add(typeof(GroupType), "A", SoapAtts);

      // Add another SoapEnumAttribute for the GroupType.B enumerator.
      // Instead of //B// it will be "East".
      SoapAtts= new SoapAttributes();
      soapEnum = new SoapEnumAttribute();
      soapEnum.Name = "East";
      SoapAtts.SoapEnum = soapEnum;
      soapOver.Add(typeof(GroupType), "B", SoapAtts);

      // Create an XmlSerializer used for overriding.
      XmlTypeMapping map = 
      new SoapReflectionImporter(soapOver).
      ImportTypeMapping(typeof(Group));
      XmlSerializer ser = new XmlSerializer(map);
      Group myGroup = new Group();
      myGroup.GroupName = ".NET";
      myGroup.Grouptype = GroupType.B;
      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(fileName);
      ser.Serialize(writer, myGroup);
      writer.Close();
   	}
}

import System.*;
import System.IO.*;
import System.Xml.*;
import System.Xml.Serialization.*;

public class Group
{
    public String groupName;
    public GroupType groupType;
} //Group

public class GroupType
{
    // Use the SoapEnumAttribute to instruct the XmlSerializer
    // to generate Small and Large instead of a and b.
    public int member;

    public GroupType()
    {
        member = 0;
    } //GroupType

    public GroupType(int n)
    {
        member = n;
    } //GroupType

    /** @attribute SoapEnum("Small")
     */
    public static int a = 0;

    /** @attribute SoapEnum("Large")
     */
    public static int b = 1;
} //GroupType

public class Run
{
    public static void main(String[] args)
    {
        Run test = new Run();
        test.SerializeObject("SoapEnum.xml");
        test.SerializeOverride("SoapOverride.xml");
        Console.WriteLine("Fininished writing two files");
    } //main

    private void SerializeObject(String fileName)
    {
        // Writing the file requires a TextWriter.
        TextWriter writer = new StreamWriter(fileName);
        // Create an instance of the Class that will be serialized.
        Group myGroup = new Group();
        // Set the object properties.
        myGroup.groupName = ".NET";
        myGroup.groupType = new GroupType(GroupType.a);
        // Create an instance of the XmlSerializer Class.
        XmlSerializer mySerializer = new XmlSerializer(myGroup.GetType());
        // Serialize the Class, and close the TextWriter.
        mySerializer.Serialize(writer, myGroup);
        writer.Close();
    } //SerializeObject

    private void SerializeOverride(String fileName)
    {
        SoapAttributeOverrides soapOver = new SoapAttributeOverrides();
        SoapAttributes SoapAtts = new SoapAttributes();
        // Add a SoapEnumAttribute for the GroupType.a enumerator.       
        // Instead of 'a'  it will be "West".
        SoapEnumAttribute soapEnum = new SoapEnumAttribute("West");
        // Override the "a" enumerator.
        SoapAtts.set_SoapEnum(soapEnum);
        soapOver.Add(GroupType.class.ToType(), "a", SoapAtts);
        // Add another SoapEnumAttribute for the GroupType.b enumerator.
        // Instead of b it will be "East".
        SoapAtts = new SoapAttributes();
        soapEnum = new SoapEnumAttribute();
        soapEnum.set_Name("East");
        SoapAtts.set_SoapEnum(soapEnum);
        soapOver.Add(GroupType.class.ToType(), "b", SoapAtts);
        // Create an XmlSerializer used for overriding.
        Group myGroup = new Group();
        myGroup.groupName = ".NET";
        myGroup.groupType = new GroupType(GroupType.b);
        // Writing the file requires a TextWriter.
        TextWriter writer = new StreamWriter(fileName);
        XmlSerializer ser = new XmlSerializer(myGroup.GetType());
        ser.Serialize(writer, myGroup);
        writer.Close();
    } //SerializeOverride
} //Run

System.Object
   System.Attribute
    System.Xml.Serialization.SoapEnumAttribute

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft