SoapIncludeAttribute Class

Definition

Позволяет 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)]
public class SoapIncludeAttribute : Attribute
[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
Inheritance
SoapIncludeAttribute
Attributes

Examples

В следующем примере SoapIncludeAttribute дважды применяется к методу веб-службы XML.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). SoapIncludeAttribute позволяет методу возвращать экземпляры классов, производных от класса Vehicle.The SoapIncludeAttribute allows the method to return instances of classes derived from the Vehicle class.

Remarks

Класс 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 соответствует разделу 5 документа консорциум W3C, протоколу SOAP 1,1.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.

Чтобы сериализовать объект как закодированное сообщение SOAP, необходимо создать XmlSerializer используя XmlTypeMapping, созданный с помощью метода ImportTypeMapping класса SoapReflectionImporter.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 можно использовать для включения производных классов в документы описания службы, написанные на языке описания веб-служб (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 см. в разделе Спецификация консорциум W3C, язык описания веб-служб (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.

Constructors

SoapIncludeAttribute(Type)

Инициализирует новый экземпляр класса SoapIncludeAttribute, используя указанный тип.Initializes a new instance of the SoapIncludeAttribute class using the specified type.

Properties

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.

(Inherited from Attribute)

Methods

Equals(Object)

Возвращает значение, показывающее, равен ли экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode()

Возвращает хэш-код для этого экземпляра.Returns the hash code for this instance.

(Inherited from Attribute)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

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

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from 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.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to