/
SoapExtensionAttribute.xml
133 lines (118 loc) · 7.78 KB
/
SoapExtensionAttribute.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<Type Name="SoapExtensionAttribute" FullName="System.Web.Services.Protocols.SoapExtensionAttribute">
<TypeSignature Language="C#" Value="public abstract class SoapExtensionAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit SoapExtensionAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:System.Web.Services.Protocols.SoapExtensionAttribute" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class SoapExtensionAttribute
Inherits Attribute" />
<TypeSignature Language="F#" Value="type SoapExtensionAttribute = class
 inherit Attribute" />
<TypeSignature Language="C++ CLI" Value="public ref class SoapExtensionAttribute abstract : Attribute" />
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>When overridden in a derived class, specifies a SOAP extension should run with an XML Web service method.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
XML Web service methods created using ASP.NET can be configured to run with a SOAP extension by applying an attribute to the XML Web service method. When a custom extension attribute is added to an XML Web service method or a method on a client proxy class, ASP.NET invokes the associated extension at the appropriate time. An extension attribute is a custom attribute class deriving from <xref:System.Web.Services.Protocols.SoapExtensionAttribute>. Derived attributes must override the <xref:System.Web.Services.Protocols.SoapExtensionAttribute.ExtensionType%2A> property to return the type of extension that is associated with the attribute.
## Examples
The following `TraceExtensionAttribute` class derives from <xref:System.Web.Services.Protocols.SoapExtensionAttribute> to support applying the attribute to an XML Web service method or a method in an XML Web service client proxy class. When applied to either, the `TraceExtension` SOAP extension runs with the method.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/Classic SoapExtensionAttribute Example/CPP/source.cpp" id="Snippet1":::
:::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/SoapExtensionAttribute/Overview/source.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/Classic SoapExtensionAttribute Example/VB/source.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Services.Protocols.SoapExtension" />
<altmember cref="T:System.Web.Services.Protocols.SoapMessage" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected SoapExtensionAttribute ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Services.Protocols.SoapExtensionAttribute.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 SoapExtensionAttribute();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.Services.Protocols.SoapExtensionAttribute" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExtensionType">
<MemberSignature Language="C#" Value="public abstract Type ExtensionType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type ExtensionType" />
<MemberSignature Language="DocId" Value="P:System.Web.Services.Protocols.SoapExtensionAttribute.ExtensionType" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property ExtensionType As Type" />
<MemberSignature Language="F#" Value="member this.ExtensionType : Type" Usage="System.Web.Services.Protocols.SoapExtensionAttribute.ExtensionType" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract property Type ^ ExtensionType { Type ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>When overridden in a derived class, gets the <see cref="T:System.Type" /> of the SOAP extension.</summary>
<value>The <see cref="T:System.Type" /> of the SOAP extension.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Derived classes must override the <xref:System.Web.Services.Protocols.SoapExtensionAttribute.ExtensionType%2A> property to return the type of the SOAP extension.
## Examples
The following code example is a typical implementation of the <xref:System.Web.Services.Protocols.SoapExtensionAttribute.ExtensionType%2A> property.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/SoapExtensionAttribute/CPP/SoapExtensionAttribute.cpp" id="Snippet2":::
:::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/SoapExtensionAttribute/ExtensionType/soapextensionattribute.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/SoapExtensionAttribute/VB/soapextensionattribute.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Priority">
<MemberSignature Language="C#" Value="public abstract int Priority { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Priority" />
<MemberSignature Language="DocId" Value="P:System.Web.Services.Protocols.SoapExtensionAttribute.Priority" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Property Priority As Integer" />
<MemberSignature Language="F#" Value="member this.Priority : int with get, set" Usage="System.Web.Services.Protocols.SoapExtensionAttribute.Priority" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract property int Priority { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>When overridden in a derived class, gets or set the priority of the SOAP extension.</summary>
<value>The priority of the SOAP extension.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example is a typical implementation of the <xref:System.Web.Services.Protocols.SoapExtensionAttribute.Priority%2A> property.
SoapExtensionAttribute#3
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>