SoapEnumAttribute Klas

Definitie

public ref class SoapEnumAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field)]
public class SoapEnumAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field)>]
type SoapEnumAttribute = class
    inherit Attribute

Public Class SoapEnumAttribute
Inherits Attribute

Overname

Object

Attribute

SoapEnumAttribute

Kenmerken

AttributeUsageAttribute

Voorbeelden

In het volgende voorbeeld wordt de XmlSerializer klasse geserialiseerd die Food een opsomming bevat met de naam FoodType. De FoodType opsomming wordt overschreven door een voor elke opsomming te SoapEnumAttribute maken en de SoapEnum eigenschap van een SoapAttributes op de SoapEnumAttribute. De SoapAttributes wordt toegevoegd aan een SoapAttributeOverrides die wordt gebruikt om een 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();
    }
}

Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization

Public Class Group
   Public GroupName As String 
   Public Grouptype As GroupType 
End Class

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
End enum
 
Public Class Run
   Public Shared Sub Main()
      Dim test As Run = new Run()
      test.SerializeObject("SoapEnum.xml")
      test.SerializeOverride("SoapOverride.xml")
      Console.WriteLine("Fininished writing two files")
   End Sub

   Private Shared Sub SerializeObject(filename As string)
      ' Create an instance of the XmlSerializer Class.
      Dim mapp  As XmlTypeMapping = _
      (New SoapReflectionImporter()).ImportTypeMapping(GetType(Group))
      Dim mySerializer As XmlSerializer =  New XmlSerializer(mapp)

      ' Writing the file requires a TextWriter.
      Dim writer As TextWriter = New StreamWriter(filename)

      ' Create an instance of the Class that will be serialized.
      Dim myGroup As Group = 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()
   End Sub

   Private  Sub SerializeOverride(fileName As String)
      Dim soapOver As SoapAttributeOverrides = new SoapAttributeOverrides()
      Dim SoapAtts As SoapAttributes = new SoapAttributes()

      ' Add a SoapEnumAttribute for the GroupType.A enumerator. Instead
      ' of 'A' it will be "West".
      Dim soapEnum As SoapEnumAttribute = new SoapEnumAttribute("West")
      ' Override the "A" enumerator.
      SoapAtts.SoapEnum = soapEnum
      soapOver.Add(GetType(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(GetType(GroupType), "B", SoapAtts)

      ' Create an XmlSerializer used for overriding.
      Dim map As XmlTypeMapping = New SoapReflectionImporter _
      (soapOver).ImportTypeMapping(GetType(Group))
      Dim ser As XmlSerializer = New XmlSerializer(map)
      Dim myGroup As Group = New Group()
      myGroup.GroupName = ".NET"
      myGroup.Grouptype = GroupType.B
      ' Writing the file requires a TextWriter.
      Dim writer As TextWriter = New StreamWriter(fileName)
      ser.Serialize(writer, myGroup)
      writer.Close

   End Sub
End Class

Opmerkingen

De SoapEnumAttribute klasse behoort tot een reeks kenmerken die bepalen hoe een XmlSerializer object wordt geserialiseerd of gedeserialiseerd als gecodeerde SOAP XML. De resulterende XML voldoet aan sectie 5 van het World Wide Web Consortium-document Simple Object Access Protocol (SOAP) 1.1. Zie Attributes That Control Encoded SOAP Serialization voor een volledige lijst met vergelijkbare kenmerken.

Als u een object wilt serialiseren als een gecodeerd SOAP-bericht, moet u het XmlSerializer maken met behulp van een XmlTypeMapping gemaakt met de ImportTypeMapping methode van de SoapReflectionImporter klasse.

Gebruik de SoapEnumAttribute functie om de opsomming te wijzigen die de XmlSerializer genereert of herkent (wanneer een klasse wordt geserialiseerd of gedeserialiseerd). Als een opsomming bijvoorbeeld een lid met de naam Onebevat, maar u wilt dat de XML-uitvoer de naam Singleheeft, past u de SoapEnumAttribute naam toe op het opsommingslid en stelt u de Name eigenschap in op Enkel.

U kunt de Name eigenschapswaarde van een SoapEnumAttribute overschrijven door een exemplaar van de SoapEnumAttribute klasse te maken en deze toe te wijzen aan de SoapEnum eigenschap van een SoapAttributes. Zie het SoapAttributeOverrides klasoverzicht voor meer informatie.

Als u een object wilt serialiseren als een gecodeerd SOAP-bericht, moet u het XmlSerializer maken met behulp van een XmlTypeMapping gemaakt met de ImportTypeMapping methode van de SoapReflectionImporter klasse.

Zie Kenmerken voor meer informatie over het gebruik van kenmerken.