SoapIncludeAttribute クラス

定義

XmlSerializer がオブジェクトをエンコード済みの SOAP XML としてシリアル化または逆シリアル化するときに、型を認識できるようにします。Allows the XmlSerializer to recognize a type when it serializes or deserializes an object as encoded SOAP XML.

public ref class SoapIncludeAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface | System.AttributeTargets.Method | System.AttributeTargets.Struct, AllowMultiple=true)]
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method | System.AttributeTargets.Struct, AllowMultiple=true)]
public class SoapIncludeAttribute : Attribute
type SoapIncludeAttribute = class
    inherit Attribute
Public Class SoapIncludeAttribute
Inherits Attribute
継承
SoapIncludeAttribute
属性

次の例ではSoapIncludeAttribute 、を XML Web サービスメソッドに2回適用します。The following example applies the SoapIncludeAttribute twice to an XML Web service method. メソッドは、型Vehicle (基底クラス) のオブジェクトを返します。The method returns an object of type Vehicle (a base class). を使用すると、メソッドはVehicleクラスから派生したクラスのインスタンスを返すことができます。 SoapIncludeAttributeThe SoapIncludeAttribute allows the method to return instances of classes derived from the Vehicle class.

注釈

クラスSoapIncludeAttributeは、がXmlSerializerオブジェクトをエンコード済みの SOAP XML としてシリアル化または逆シリアル化する方法を制御する属性のファミリに属しています。The SoapIncludeAttribute class belongs to a family of attributes that controls how the XmlSerializer serializes, or deserializes, an object as encoded SOAP XML. 生成される XML は、World Wide Web コンソーシアムドキュメント「 Simple Object Access Protocol (SOAP) 1.1」のセクション5に準拠しています。The resulting XML conforms to section 5 of the World Wide Web Consortium document, Simple Object Access Protocol (SOAP) 1.1. 類似する属性の完全な一覧については、「エンコード済み SOAP シリアル化を制御する属性」を参照してください。For a complete list of similar attributes, see Attributes That Control Encoded SOAP Serialization.

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

を適用SoapIncludeAttributeする場合は、 Type派生クラスのを指定します。When applying the SoapIncludeAttribute, specify the Type of the derived class. が基底XmlSerializerクラスと派生クラスの両方を含むオブジェクトをシリアル化すると、両方のオブジェクトの種類を認識できます。When the XmlSerializer serializes objects that include both the base and the derived classes, it can then recognize both object types.

を使用するとSoapIncludeAttribute 、Web サービス記述言語 (WSDL) で記述されたサービスの説明ドキュメントに派生クラスを含めることができます。You can use the SoapIncludeAttribute to include derived classes in service description documents that are written in the Web Services Description Language (WSDL). たとえば、メソッドがを返すObject場合は、をメソッドSoapIncludeAttributeに適用し、返される実際の型を指定します。For example, if a method returns an Object, apply the SoapIncludeAttribute to the method and specify the actual types that should be returned.

WSDL の詳細については、「World Wide Web コンソーシアム specification、 Web Services Description Language (wsdl) 1.1」を参照してください。For more information about WSDL, see World Wide Web Consortium specification, Web Services Description Language (WSDL) 1.1.

属性の使用方法の詳細については、「属性」を参照してください。For more information about using attributes, see Attributes.

コンストラクター

SoapIncludeAttribute(Type)

型を指定して、SoapIncludeAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the SoapIncludeAttribute class using the specified type.

プロパティ

Type

オブジェクトをシリアル化または逆シリアル化するときに使用するオブジェクトの型を取得または設定します。Gets or sets the type of the object to use when serializing or deserializing an object.

TypeId

派生クラスで実装されると、この Attribute の一意の識別子を取得します。When implemented in a derived class, gets a unique identifier for this Attribute.

(継承元 Attribute)

メソッド

Equals(Object)

このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。Returns a value that indicates whether this instance is equal to a specified object.

(継承元 Attribute)
GetHashCode()

このインスタンスのハッシュ コードを返します。Returns the hash code for this instance.

(継承元 Attribute)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
IsDefaultAttribute()

派生クラスでオーバーライドされるとき、このインスタンスの値が派生クラスの既定値であるかどうかを示します。When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(継承元 Attribute)
Match(Object)

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(継承元 Attribute)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(継承元 Object)

明示的なインターフェイスの実装

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

一連の名前を対応する一連のディスパッチ識別子に割り当てます。Maps a set of names to a corresponding set of dispatch identifiers.

(継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。Retrieves the type information for an object, which can be used to get the type information for an interface.

(継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)

オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。Provides access to properties and methods exposed by an object.

(継承元 Attribute)

適用対象