SoapEnumAttribute Sınıf

Tanım

Ad Alanı:

System.Xml.Serialization

Bütünleştirilmiş Kodlar:

netstandard.dll, System.Xml.XmlSerializer.dll

Kaynak:

SoapEnumAttribute.cs

XmlSerializer bir numaralandırma üyesini nasıl seri hale getirerek denetler.

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

Devralma

Object

Attribute

SoapEnumAttribute

Öznitelikler

AttributeUsageAttribute

Örnekler

Aşağıdaki örnekte XmlSerializer adlı FoodTypebir sabit listesi içeren adlı Food sınıfı seri hale getirmek için kullanılır. NumaralandırmaFoodType, her numaralandırma için bir SoapEnumAttribute oluşturularak ve özelliği SoapAttributes olarak ayarlanarak SoapEnum geçersiz kılınmış SoapEnumAttributeolur. SoapAttributes, oluşturmak için kullanılan öğesine XmlSerializereklenirSoapAttributeOverrides.

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

Açıklamalar

sınıfı, SoapEnumAttribute nesnesinin kodlanmış SOAP XML olarak nasıl seri hale getirileceğini veya seri durumdan XmlSerializer çıkarıldığını denetleen bir öznitelik ailesine aittir. Sonuçta elde edilen XML, World Wide Web Konsorsiyumu belgesinin Basit Nesne Erişim Protokolü (SOAP) 1.1'in 5. bölümüne uygundur. Benzer özniteliklerin tam listesi için bkz. Kodlanmış SOAP Serileştirmesini Denetleen Öznitelikler.

Bir nesneyi kodlanmış SOAP iletisi olarak seri hale getirmek için sınıfı yöntemiyle SoapReflectionImporterImportTypeMapping oluşturulan kullanarak XmlTypeMapping öğesini oluşturmanız XmlSerializer gerekir.

SoapEnumAttribute(sırasıyla bir sınıfı serileştirdiğinde veya seri durumdan çıkardığında) oluşturduğu veya tanıdığı numaralandırmayı XmlSerializer değiştirmek için öğesini kullanın. Örneğin, bir sabit listesi adlı Onebir üye içeriyorsa ancak XML çıkışının adlı Singleolmasını tercih ediyorsanız, öğesini numaralandırma üyesine uygulayın SoapEnumAttribute ve özelliğini "Tek" olarak ayarlayın Name .

sınıfının bir örneğini NameSoapEnumAttribute oluşturup özelliğine atayarak öğesinin SoapAttributesSoapEnum özellik değerini SoapEnumAttribute geçersiz kılabilirsiniz. Ayrıntılar için bkz. sınıfa SoapAttributeOverrides genel bakış.

Bir nesneyi kodlanmış SOAP iletisi olarak seri hale getirmek için sınıfı yöntemiyle SoapReflectionImporterImportTypeMapping oluşturulan kullanarak XmlTypeMapping öğesini oluşturmanız XmlSerializer gerekir.

Uyarı

uzun yerine SoapEnumAttributekodunuzda sözcüğünü SoapEnum kullanabilirsiniz.

Öznitelikleri kullanma hakkında daha fazla bilgi için bkz . Öznitelikler.

Oluşturucular

Name	Description
SoapEnumAttribute()	SoapEnumAttribute sınıfının yeni bir örneğini başlatır.
SoapEnumAttribute(String)	Belirtilen öğe adını kullanarak sınıfın SoapEnumAttribute yeni bir örneğini başlatır.

Özellikler

Name	Description
Name	Bir sabit listesi seri hale getirildiğinde XmlSerializer bir XML belgesinde oluşturulan değeri veya numaralandırma üyesini seri durumdan çıkardığında tanınan değeri alır veya ayarlar.
TypeId	Türetilmiş bir sınıfta uygulandığında, bu Attributeiçin benzersiz bir tanımlayıcı alır. (Devralındığı yer: Attribute)

Yöntemler

Name	Description
Equals(Object)	Bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
GetHashCode()	Bu örneğin karma kodunu döndürür. (Devralındığı yer: Attribute)
GetType()	Geçerli örneğin Type alır. (Devralındığı yer: Object)
IsDefaultAttribute()	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin değerinin türetilmiş sınıf için varsayılan değer olup olmadığını gösterir. (Devralındığı yer: Attribute)
Match(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
MemberwiseClone()	Geçerli Objectbasit bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden bir dize döndürür. (Devralındığı yer: Object)