SoapIncludeAttribute Класс

Определение

Пространство имен:

System.Xml.Serialization

Сборки:

netstandard.dll, System.Xml.XmlSerializer.dll

Исходный код:

SoapIncludeAttribute.cs

Позволяет XmlSerializer распознавать тип при сериализации или десериализации объекта в формате 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.Interface | System.AttributeTargets.Method | System.AttributeTargets.Struct, AllowMultiple=true)>]
type SoapIncludeAttribute = class
    inherit Attribute

Public Class SoapIncludeAttribute
Inherits Attribute

Наследование

Object

Attribute

SoapIncludeAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере два раза применяется SoapIncludeAttribute к методу веб-службы XML. Метод возвращает объект типа Vehicle (базовый класс). Позволяет SoapIncludeAttribute методу возвращать экземпляры классов, производных от Vehicle класса.

Комментарии

Класс SoapIncludeAttribute принадлежит семейству атрибутов, которые управляют XmlSerializer сериализацией или десериализацией объекта в формате SOAP XML. Полученный XML-код соответствует разделу 5 документа консорциума Всемирного веб-консорциума Simple Object Access Protocol (SOAP) 1.1. Полный список аналогичных атрибутов см. в разделе Атрибуты, которые управляют сериализацией в кодировке SOAP.

Чтобы сериализовать объект в виде закодированного сообщения SOAP, необходимо создать XmlSerializer созданный с XmlTypeMapping помощью ImportTypeMapping метода SoapReflectionImporter класса.

При применении SoapIncludeAttributeукажите Type производный класс. XmlSerializer При сериализации объектов, включающих как базовые, так и производные классы, он может распознать оба типа объектов.

Вы можете использовать производные SoapIncludeAttribute классы в документы описания служб, написанные на языке описания веб-служб (WSDL). Например, если метод возвращает объект, примените ObjectSoapIncludeAttribute его к методу и укажите фактические типы, которые должны быть возвращены.

Дополнительные сведения о WSDL см. в спецификации консорциума WSDL, языке описания веб-служб (WSDL) 1.1.

Дополнительные сведения об использовании атрибутов см. в разделе "Атрибуты".

Конструкторы

Имя	Описание
SoapIncludeAttribute(Type)	Инициализирует новый экземпляр класса с помощью указанного SoapIncludeAttribute типа.

Свойства

Имя	Описание
Type	Возвращает или задает тип объекта, используемого при сериализации или десериализации объекта.
TypeId	При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute)

Методы

Имя	Описание
Equals(Object)	Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
GetHashCode()	Возвращает хэш-код для этого экземпляра. (Унаследовано от Attribute)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)