SoapElementAttribute クラス

[アーティクル]
03/28/2008

XmlSerializer がパブリックメンバの値をエンコード済みの SOAP XML 要素としてシリアル化することを指定します。

この型のすべてのメンバの一覧については、SoapElementAttribute メンバを参照してください。

System.Object
System.Attribute
System.Xml.Serialization.SoapElementAttribute

<AttributeUsage(AttributeTargets.Property Or AttributeTargets.Field _
   Or AttributeTargets.Parameter Or AttributeTargets.ReturnValue)>
Public Class SoapElementAttribute   Inherits Attribute
[C#]
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field
   | AttributeTargets.Parameter | AttributeTargets.ReturnValue)]
public class SoapElementAttribute : Attribute
[C++]
[AttributeUsage(AttributeTargets::Property |
   AttributeTargets::Field | AttributeTargets::Parameter |
   AttributeTargets::ReturnValue)]
public __gc class SoapElementAttribute : public Attribute
[JScript]
public
   AttributeUsage(AttributeTargets.Property | AttributeTargets.Field |
   AttributeTargets.Parameter | AttributeTargets.ReturnValue)
class SoapElementAttribute extends Attribute

スレッドセーフ

この型の public static (Visual Basicでは Shared) のすべてのメンバは、マルチスレッド操作で安全に使用できます。インスタンスのメンバの場合は、スレッドセーフであるとは限りません。

解説

SoapElementAttribute クラスは、 XmlSerializer がオブジェクトをエンコード済み SOAP XML としてシリアル化または逆シリアル化する方法を制御する一連の属性のうちの 1 つです。結果として生成される XML は、W3C (World Wide Web Consortium) (www.w3.org) のドキュメント『Simple Object Access Protocol (SOAP) 1.1』のセクション 5 に準拠します。類似する属性の完全な一覧については、「エンコード済み SOAP シリアル化を制御する属性」を参照してください。

オブジェクトをエンコード済み SOAP メッセージとしてシリアル化するには、 SoapReflectionImporter クラスの ImportTypeMapping メソッドで作成された XmlTypeMapping を使用して、 XmlSerializer を構築する必要があります。

パブリックフィールドをエンコード済みの SOAP XML 要素としてシリアル化することを XmlSerializer に指示するには、そのフィールドに SoapElementAttribute を適用します。属性の代替名を指定するには、 AttributeName プロパティを設定します。属性に対して、特定の XML スキーマ定義言語 (XSD: XML Schema Definition) のデータ型を指定する必要がある場合は、 DataType プロパティを設定します。属性が特定の XML 名前空間に属する場合は、 Namespace プロパティを設定します。

属性の使用方法については、「属性を使用したメタデータの拡張」を参照してください。

使用例

[Visual Basic, C#, C++] Vehicle という名前のフィールドが含まれている Transportation という名前のクラスのインスタンスをシリアル化する例を次に示します。このフィールドには、 SoapElementAttribute が適用されています。このフィールドがシリアル化されると、その XML 要素名は "Vehicle" ではなく "Wheels" になります。 SerializeOverride メソッドは、 SoapElementAttribute を作成し、 SoapAttributes の SoapElement プロパティに、作成した SoapElementAttribute を設定します。この SoapAttributes が、 XmlTypeMapping を作成するために使用される SoapAttributeOverrides に追加されます。作成された XmlTypeMapping を使用して XmlSerializer が構築され、 Transportation クラスのインスタンスが再びシリアル化されます。 SoapElementAttribute を使用してシリアル化がオーバーライドされるため、生成された XML 要素の名前は "Wheels" ではなく "Truck" になります。

 
Imports System
Imports System.IO
Imports System.Xml.Serialization
Imports System.Collections
Imports System.Xml
Imports System.Text
Public Class Transportation
   ' The SoapElementAttribute specifies that the
   ' generated XML element name will be "Wheels"
   ' instead of "Vehicle".
   <SoapElement("Wheels")> Public Vehicle As String 
   <SoapElement(DataType:= "dateTime")> _
   public CreationDate As DateTime    
   <SoapElement(IsNullable:= true)> _
   public thing As Thing
End Class

Public Class Thing
   <SoapElement(IsNullable:=true)> public ThingName As string 
End Class

Public Class Test

   Shared Sub Main()
      Dim t As Test = New Test()
      t.SerializeObject("SoapElementOriginalVb.xml")
      t.SerializeOverride("SoapElementOverrideVb.xml")
      Console.WriteLine("Finished writing two XML files.")
   End Sub

   ' Return an XmlSerializer used for overriding.
   Public Function CreateSoapOverrider() As XmlSerializer 
      ' Create the SoapAttributes and SoapAttributeOverrides objects.
      Dim soapAttrs As SoapAttributes = New SoapAttributes()

      Dim soapOverrides As SoapAttributeOverrides = _
      New SoapAttributeOverrides()
            
      ' Create a SoapElementAttribute to override 
      ' the Vehicles property. 
      Dim soapElement1 As SoapElementAttribute = _
      New SoapElementAttribute("Truck")
      ' Set the SoapElement to the object.
      soapAttrs.SoapElement= soapElement1

      ' Add the SoapAttributes to the SoapAttributeOverrides,
      ' specifying the member to override. 
      soapOverrides.Add(GetType(Transportation), "Vehicle", soapAttrs)
      
      ' Create the XmlSerializer, and return it.
      Dim myTypeMapping As XmlTypeMapping = (New _
      SoapReflectionImporter (soapOverrides)).ImportTypeMapping _
      (GetType(Transportation))
      return New XmlSerializer(myTypeMapping)
   End Function

   Public Sub SerializeOverride(filename As String)
      ' Create an XmlSerializer instance.
      Dim ser As XmlSerializer = CreateSoapOverrider()

      ' Create the object and serialize it.
      Dim myTransportation As Transportation = _
      New Transportation()

      myTransportation.Vehicle = "MyCar"
      myTransportation.CreationDate = DateTime.Now
      myTransportation.thing= new Thing()
      
      Dim writer As XmlTextWriter = _
      New XmlTextWriter(filename, Encoding.UTF8)
      writer.Formatting = Formatting.Indented
      writer.WriteStartElement("wrapper")
      ser.Serialize(writer, myTransportation)
      writer.WriteEndElement()
      writer.Close()
   End Sub

   Public Sub SerializeObject(filename As String)
      ' Create an XmlSerializer instance.
      Dim ser As XmlSerializer = _
      New XmlSerializer(GetType(Transportation))
      
      Dim myTransportation As Transportation = _
      New Transportation()
      
      myTransportation.Vehicle = "MyCar"
      myTransportation.CreationDate=DateTime.Now
      myTransportation.thing= new Thing()

      Dim writer As XmlTextWriter = _
      new XmlTextWriter(filename, Encoding.UTF8)
      writer.Formatting = Formatting.Indented
      writer.WriteStartElement("wrapper")
      ser.Serialize(writer, myTransportation)
      writer.WriteEndElement()
      writer.Close()
   End Sub
End Class

[C#] 
using System;
using System.IO;
using System.Xml.Serialization;
using System.Collections;
using System.Xml;
using System.Text;
public class Transportation
{
   // The SoapElementAttribute specifies that the
   // generated XML element name will be "Wheels"
   // instead of "Vehicle".
   [SoapElement("Wheels")]
   public string Vehicle;
   [SoapElement(DataType = "dateTime")]
   public DateTime CreationDate;
   [SoapElement(IsNullable = true)]
   public Thing thing;
   
}

public class Thing{ 
   [SoapElement(IsNullable=true)] public string ThingName;
}

public class Test
{
   public static void Main()
   {
      Test t = new Test();
      t.SerializeObject("SoapElementOriginal.xml");
      t.SerializeOverride("SoapElementOverride.xml");
      Console.WriteLine("Finished writing two XML files.");
   }

   // Return an XmlSerializer used for overriding.
   public XmlSerializer CreateSoapOverrider()
   {
      // Create the SoapAttributes and SoapAttributeOverrides objects.
      SoapAttributes soapAttrs = new SoapAttributes();

      SoapAttributeOverrides soapOverrides = 
      new SoapAttributeOverrides();
            
      /* Create an SoapElementAttribute to override 
      the Vehicles property. */
      SoapElementAttribute soapElement1 = 
      new SoapElementAttribute("Truck");
      // Set the SoapElement to the object.
      soapAttrs.SoapElement= soapElement1;

      /* Add the SoapAttributes to the SoapAttributeOverrides,
      specifying the member to override. */
      soapOverrides.Add(typeof(Transportation), "Vehicle", soapAttrs);
      
      // Create the XmlSerializer, and return it.
      XmlTypeMapping myTypeMapping = (new SoapReflectionImporter
      (soapOverrides)).ImportTypeMapping(typeof(Transportation));
      return new XmlSerializer(myTypeMapping);
   }

   public void SerializeOverride(string filename)
   {
      // Create an XmlSerializer instance.
      XmlSerializer ser = CreateSoapOverrider();

      // Create the object and serialize it.
      Transportation myTransportation = 
      new Transportation();

      myTransportation.Vehicle = "MyCar";
      myTransportation.CreationDate=DateTime.Now;
      myTransportation.thing = new Thing();

      XmlTextWriter writer = 
      new XmlTextWriter(filename, Encoding.UTF8);
      writer.Formatting = Formatting.Indented;
      writer.WriteStartElement("wrapper");
      ser.Serialize(writer, myTransportation);
      writer.WriteEndElement();
      writer.Close();
   }
   public void SerializeObject(string filename){
      // Create an XmlSerializer instance.
      XmlSerializer ser = new XmlSerializer(typeof(Transportation));
      Transportation myTransportation = 
      new Transportation();
      myTransportation.Vehicle = "MyCar";
      myTransportation.CreationDate = DateTime.Now;
      myTransportation.thing = new Thing();
      XmlTextWriter writer = 
      new XmlTextWriter(filename, Encoding.UTF8);
      writer.Formatting = Formatting.Indented;
      writer.WriteStartElement("wrapper");
      ser.Serialize(writer, myTransportation);
      writer.WriteEndElement();
      writer.Close();
   }
}

[C++] 
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml::Serialization;
using namespace System::Collections;
using namespace System::Xml;
using namespace System::Text;

__gc public class Thing
{
public:
   [SoapElement(IsNullable=true)] 
   String* ThingName;
};

__gc public class Transportation
{
   // The SoapElementAttribute specifies that the
   // generated XML element name will be S"Wheels"
   // instead of S"Vehicle".
public:
   [SoapElement(S"Wheels")]
   String* Vehicle;

   [SoapElement(DataType = S"dateTime")]
   DateTime CreationDate;

   [SoapElement(IsNullable = true)]
   Thing * thing;
};

__gc public class Test
{
   // Return an XmlSerializer used for overriding.
public:
   XmlSerializer * CreateSoapOverrider() 
   {
      // Create the SoapAttributes and SoapAttributeOverrides objects.
      SoapAttributes* soapAttrs = new SoapAttributes();

      SoapAttributeOverrides* soapOverrides = new SoapAttributeOverrides();

      // Create an SoapElementAttribute to the Vehicles property.
      SoapElementAttribute* soapElement1 = new SoapElementAttribute(S"Truck");

      // Set the SoapElement to the Object*.
      soapAttrs -> SoapElement= soapElement1;

      // Add the SoapAttributes to the SoapAttributeOverrides,specifying the member to.
      soapOverrides -> Add(__typeof(Transportation), S"Vehicle", soapAttrs);

      // Create the XmlSerializer, and return it.
      XmlTypeMapping * myTypeMapping = (new SoapReflectionImporter
         (soapOverrides)) -> ImportTypeMapping(__typeof(Transportation));
      return new XmlSerializer(myTypeMapping);
   }

   void SerializeOverride(String* filename) 
   {
      // Create an XmlSerializer instance.
      XmlSerializer * ser = CreateSoapOverrider();

      // Create the Object* and serialize it.
      Transportation* myTransportation = new Transportation();

      myTransportation -> Vehicle = S"MyCar";
      myTransportation -> CreationDate=DateTime::Now;
      myTransportation -> thing = new Thing();

      XmlTextWriter* writer = new XmlTextWriter(filename, Encoding::UTF8);
      writer -> Formatting = Formatting::Indented;
      writer -> WriteStartElement(S"wrapper");
      ser -> Serialize(writer, myTransportation);
      writer -> WriteEndElement();
      writer -> Close();
   }

   void SerializeObject(String* filename) 
   {
      // Create an XmlSerializer instance.
      XmlSerializer* ser = new XmlSerializer(__typeof(Transportation));
      Transportation* myTransportation = new Transportation();
      myTransportation -> Vehicle = S"MyCar";
      myTransportation -> CreationDate = DateTime::Now;
      myTransportation -> thing = new Thing();
      XmlTextWriter* writer = new XmlTextWriter(filename, Encoding::UTF8);
      writer -> Formatting = Formatting::Indented;
      writer -> WriteStartElement(S"wrapper");
      ser -> Serialize(writer, myTransportation);
      writer -> WriteEndElement();
      writer -> Close();
   }
};

int main() 
{
   Test* t = new Test();
   t -> SerializeObject(S"SoapElementOriginal.xml");
   t -> SerializeOverride(S"SoapElementOverride.xml");
   Console::WriteLine(S"Finished writing two XML files.");
}

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタボタンをクリックします。

必要条件

名前空間: System.Xml.Serialization

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ, .NET Compact Framework - Windows CE .NET

アセンブリ: System.Xml (System.Xml.dll 内)

参照

SoapElementAttribute メンバ | System.Xml.Serialization 名前空間

次の方法で共有

SoapElementAttribute クラス

スレッドセーフ

解説

使用例

必要条件

参照

その他のリソース