-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
AsyncCodeActivity.xml
298 lines (285 loc) · 20.5 KB
/
AsyncCodeActivity.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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
<Type Name="AsyncCodeActivity" FullName="System.Activities.AsyncCodeActivity">
<TypeSignature Language="C#" Value="public abstract class AsyncCodeActivity : System.Activities.Activity" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit AsyncCodeActivity extends System.Activities.Activity" />
<TypeSignature Language="DocId" Value="T:System.Activities.AsyncCodeActivity" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class AsyncCodeActivity
Inherits Activity" />
<TypeSignature Language="F#" Value="type AsyncCodeActivity = class
 inherit Activity" />
<TypeSignature Language="C++ CLI" Value="public ref class AsyncCodeActivity abstract : System::Activities::Activity" />
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Activities.Activity</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Manages asynchronous code activity execution from start to completion. This is an abstract class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to derive a class from <xref:System.Activities.AsyncCodeActivity> to create a custom activity.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/async/cs/filewriter.cs" id="Snippet0":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected AsyncCodeActivity ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.AsyncCodeActivity.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 AsyncCodeActivity();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Creates a new instance of the <see cref="T:System.Activities.AsyncCodeActivity" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BeginExecute">
<MemberSignature Language="C#" Value="protected abstract IAsyncResult BeginExecute (System.Activities.AsyncCodeActivityContext context, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.IAsyncResult BeginExecute(class System.Activities.AsyncCodeActivityContext context, class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.AsyncCodeActivity.BeginExecute(System.Activities.AsyncCodeActivityContext,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function BeginExecute (context As AsyncCodeActivityContext, callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="F#" Value="abstract member BeginExecute : System.Activities.AsyncCodeActivityContext * AsyncCallback * obj -> IAsyncResult" Usage="asyncCodeActivity.BeginExecute (context, callback, state)" />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract IAsyncResult ^ BeginExecute(System::Activities::AsyncCodeActivityContext ^ context, AsyncCallback ^ callback, System::Object ^ state);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.Activities.AsyncCodeActivityContext" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="context">Information that defines the execution environment for the <see cref="T:System.Activities.AsyncCodeActivity" />.</param>
<param name="callback">The method to be called after the asynchronous activity and completion notification have occurred.</param>
<param name="state">An object that saves variable information for an instance of an asynchronous activity.</param>
<summary>When implemented in a derived class and using the specified execution context, callback method, and user state, enqueues an asynchronous activity in a run-time workflow.</summary>
<returns>The object that saves variable information for an instance of an asynchronous activity.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to override the <xref:System.Activities.AsyncCodeActivity.BeginExecute%2A> method in a custom activity.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/async/cs/filewriter.cs" id="Snippet1":::
]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="CacheMetadata">
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Serves as a virtual method and converts information obtained by cache reflection into arguments for an asynchronous activity.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Custom activity authors can provide validation logic in an activity's <xref:System.Activities.AsyncCodeActivity.CacheMetadata%2A> override. Any exceptions that are thrown from <xref:System.Activities.AsyncCodeActivity.CacheMetadata%2A> are not treated as validation errors. These exceptions will escape from the call to <xref:System.Activities.Validation.ActivityValidationServices.Validate%2A> and must be handled by the caller.
]]></format>
</remarks>
</Docs>
</MemberGroup>
<Member MemberName="CacheMetadata">
<MemberSignature Language="C#" Value="protected override sealed void CacheMetadata (System.Activities.ActivityMetadata metadata);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void CacheMetadata(valuetype System.Activities.ActivityMetadata metadata) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.AsyncCodeActivity.CacheMetadata(System.Activities.ActivityMetadata)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides NotOverridable Sub CacheMetadata (metadata As ActivityMetadata)" />
<MemberSignature Language="F#" Value="override this.CacheMetadata : System.Activities.ActivityMetadata -> unit" Usage="asyncCodeActivity.CacheMetadata metadata" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void CacheMetadata(System::Activities::ActivityMetadata metadata);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadata" Type="System.Activities.ActivityMetadata" />
</Parameters>
<Docs>
<param name="metadata">Not implemented.</param>
<summary>Not implemented. Use <see cref="M:System.Activities.AsyncCodeActivity.CacheMetadata(System.Activities.CodeActivityMetadata)" /> instead.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CacheMetadata">
<MemberSignature Language="C#" Value="protected virtual void CacheMetadata (System.Activities.CodeActivityMetadata metadata);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void CacheMetadata(valuetype System.Activities.CodeActivityMetadata metadata) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.AsyncCodeActivity.CacheMetadata(System.Activities.CodeActivityMetadata)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub CacheMetadata (metadata As CodeActivityMetadata)" />
<MemberSignature Language="F#" Value="override this.CacheMetadata : System.Activities.CodeActivityMetadata -> unit" Usage="asyncCodeActivity.CacheMetadata metadata" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual void CacheMetadata(System::Activities::CodeActivityMetadata metadata);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadata" Type="System.Activities.CodeActivityMetadata" />
</Parameters>
<Docs>
<param name="metadata">
<see cref="T:System.Activities.CodeActivityMetadata" /> object that contains data for a set of asynchronous activity arguments.</param>
<summary>Serves as a virtual method and converts information obtained by cache reflection into arguments for an asynchronous activity.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Custom activity authors can provide validation logic in an activity's <xref:System.Activities.AsyncCodeActivity.CacheMetadata%2A> override. Any exceptions that are thrown from <xref:System.Activities.AsyncCodeActivity.CacheMetadata%2A> are not treated as validation errors. These exceptions will escape from the call to <xref:System.Activities.Validation.ActivityValidationServices.Validate%2A> and must be handled by the caller.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Cancel">
<MemberSignature Language="C#" Value="protected virtual void Cancel (System.Activities.AsyncCodeActivityContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Cancel(class System.Activities.AsyncCodeActivityContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.AsyncCodeActivity.Cancel(System.Activities.AsyncCodeActivityContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub Cancel (context As AsyncCodeActivityContext)" />
<MemberSignature Language="F#" Value="abstract member Cancel : System.Activities.AsyncCodeActivityContext -> unit
override this.Cancel : System.Activities.AsyncCodeActivityContext -> unit" Usage="asyncCodeActivity.Cancel context" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual void Cancel(System::Activities::AsyncCodeActivityContext ^ context);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.Activities.AsyncCodeActivityContext" />
</Parameters>
<Docs>
<param name="context">Information that defines the execution environment for the <see cref="T:System.Activities.AsyncCodeActivity" />.</param>
<summary>When implemented in a derived class and using the specified execution environment information, notifies the workflow runtime that the asynchronous activity operation has reached an early completion. Serves as a virtual method.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EndExecute">
<MemberSignature Language="C#" Value="protected abstract void EndExecute (System.Activities.AsyncCodeActivityContext context, IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void EndExecute(class System.Activities.AsyncCodeActivityContext context, class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.AsyncCodeActivity.EndExecute(System.Activities.AsyncCodeActivityContext,System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Sub EndExecute (context As AsyncCodeActivityContext, result As IAsyncResult)" />
<MemberSignature Language="F#" Value="abstract member EndExecute : System.Activities.AsyncCodeActivityContext * IAsyncResult -> unit" Usage="asyncCodeActivity.EndExecute (context, result)" />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract void EndExecute(System::Activities::AsyncCodeActivityContext ^ context, IAsyncResult ^ result);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.Activities.AsyncCodeActivityContext" />
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="context">Information that defines the execution environment for the <see cref="T:System.Activities.AsyncCodeActivity" />.</param>
<param name="result">The implemented <see cref="T:System.IAsyncResult" /> that returns the status of an asynchronous activity when execution ends.</param>
<summary>When implemented in a derived class and using the specified execution environment information, notifies the workflow runtime that the associated asynchronous activity operation has completed.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to override the <xref:System.Activities.AsyncCodeActivity.EndExecute%2A> method in a custom activity.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/async/cs/filewriter.cs" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Implementation">
<MemberSignature Language="C#" Value="protected override sealed Func<System.Activities.Activity> Implementation { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`1<class System.Activities.Activity> Implementation" />
<MemberSignature Language="DocId" Value="P:System.Activities.AsyncCodeActivity.Implementation" />
<MemberSignature Language="VB.NET" Value="Protected Overrides NotOverridable Property Implementation As Func(Of Activity)" />
<MemberSignature Language="F#" Value="member this.Implementation : Func<System.Activities.Activity> with get, set" Usage="System.Activities.AsyncCodeActivity.Implementation" />
<MemberSignature Language="C++ CLI" Value="protected:
 property Func<System::Activities::Activity ^> ^ Implementation { Func<System::Activities::Activity ^> ^ get(); void set(Func<System::Activities::Activity ^> ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.IgnoreDataMember]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.IgnoreDataMember>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Func<System.Activities.Activity></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets <see langword="null" /> or throws an error when there is an attempt to set the value of this property.</summary>
<value>An activity function.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ImplementationVersion">
<MemberSignature Language="C#" Value="protected internal override sealed Version ImplementationVersion { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Version ImplementationVersion" />
<MemberSignature Language="DocId" Value="P:System.Activities.AsyncCodeActivity.ImplementationVersion" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides NotOverridable Property ImplementationVersion As Version" />
<MemberSignature Language="F#" Value="member this.ImplementationVersion : Version with get, set" Usage="System.Activities.AsyncCodeActivity.ImplementationVersion" />
<MemberSignature Language="C++ CLI" Value="protected public:
 property Version ^ ImplementationVersion { Version ^ get(); void set(Version ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Version</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the implementation version of the activity.</summary>
<value>The implementation version of the activity.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnCreateDynamicUpdateMap">
<MemberSignature Language="C#" Value="protected override sealed void OnCreateDynamicUpdateMap (System.Activities.DynamicUpdate.UpdateMapMetadata metadata, System.Activities.Activity originalActivity);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnCreateDynamicUpdateMap(class System.Activities.DynamicUpdate.UpdateMapMetadata metadata, class System.Activities.Activity originalActivity) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.AsyncCodeActivity.OnCreateDynamicUpdateMap(System.Activities.DynamicUpdate.UpdateMapMetadata,System.Activities.Activity)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides NotOverridable Sub OnCreateDynamicUpdateMap (metadata As UpdateMapMetadata, originalActivity As Activity)" />
<MemberSignature Language="F#" Value="override this.OnCreateDynamicUpdateMap : System.Activities.DynamicUpdate.UpdateMapMetadata * System.Activities.Activity -> unit" Usage="asyncCodeActivity.OnCreateDynamicUpdateMap (metadata, originalActivity)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void OnCreateDynamicUpdateMap(System::Activities::DynamicUpdate::UpdateMapMetadata ^ metadata, System::Activities::Activity ^ originalActivity);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadata" Type="System.Activities.DynamicUpdate.UpdateMapMetadata" Index="0" FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<Parameter Name="originalActivity" Type="System.Activities.Activity" Index="1" FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
</Parameters>
<Docs>
<param name="metadata">The metadata used.</param>
<param name="originalActivity">The original activity.</param>
<summary>Raises an event when creating a map for the dynamic update.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>