/
SequentialWorkflowActivity.xml
308 lines (296 loc) · 20.7 KB
/
SequentialWorkflowActivity.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
299
300
301
302
303
304
305
306
307
308
<Type Name="SequentialWorkflowActivity" FullName="System.Workflow.Activities.SequentialWorkflowActivity">
<TypeSignature Language="C#" Value="public class SequentialWorkflowActivity : System.Workflow.Activities.SequenceActivity" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SequentialWorkflowActivity extends System.Workflow.Activities.SequenceActivity" />
<TypeSignature Language="DocId" Value="T:System.Workflow.Activities.SequentialWorkflowActivity" />
<TypeSignature Language="VB.NET" Value="Public Class SequentialWorkflowActivity
Inherits SequenceActivity" />
<TypeSignature Language="F#" Value="type SequentialWorkflowActivity = class
 inherit SequenceActivity" />
<TypeSignature Language="C++ CLI" Value="public ref class SequentialWorkflowActivity : System::Workflow::Activities::SequenceActivity" />
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Workflow.Activities.SequenceActivity</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Designer(typeof(System.Workflow.Activities.SequentialWorkflowDesigner), typeof(System.ComponentModel.Design.IRootDesigner))]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Designer(typeof(System.Workflow.Activities.SequentialWorkflowDesigner), typeof(System.ComponentModel.Design.IRootDesigner))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Designer(typeof(System.Workflow.Activities.SequentialWorkflowDesigner), typeof(System.ComponentModel.Design.IDesigner))]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Designer(typeof(System.Workflow.Activities.SequentialWorkflowDesigner), typeof(System.ComponentModel.Design.IDesigner))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.ToolboxItem(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.ToolboxItem(false)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Drawing.ToolboxBitmap(typeof(System.Workflow.Activities.SequentialWorkflowActivity), "Resources.SequentialWorkflow.bmp")]</AttributeName>
<AttributeName Language="F#">[<System.Drawing.ToolboxBitmap(typeof(System.Workflow.Activities.SequentialWorkflowActivity), "Resources.SequentialWorkflow.bmp")>]</AttributeName>
</Attribute>
<Attribute 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">
<AttributeName Language="C#">[System.Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a workflow that executes activities sequentially.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
> [!NOTE]
> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]
The <xref:System.Workflow.Activities.SequentialWorkflowActivity> is a <xref:System.Workflow.Activities.SequenceActivity> with `Initialized` and `Completed` events for optional processing of parameters. This makes it particularly useful as a top-level activity when you design sequential-style workflows.
The <xref:System.Workflow.Activities.SequentialWorkflowActivity> is a <xref:System.Workflow.ComponentModel.CompositeActivity>, which means the <xref:System.Workflow.Activities.SequentialWorkflowActivity> can contain other activities.
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Activities.SequentialWorkflowActivity" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SequentialWorkflowActivity ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Activities.SequentialWorkflowActivity.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 SequentialWorkflowActivity();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Activities.SequentialWorkflowActivity" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SequentialWorkflowActivity (string name);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Activities.SequentialWorkflowActivity.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String)" />
<MemberSignature Language="F#" Value="new System.Workflow.Activities.SequentialWorkflowActivity : string -> System.Workflow.Activities.SequentialWorkflowActivity" Usage="new System.Workflow.Activities.SequentialWorkflowActivity name" />
<MemberSignature Language="C++ CLI" Value="public:
 SequentialWorkflowActivity(System::String ^ name);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The user-defined name of the activity.</param>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Activities.SequentialWorkflowActivity" /> class by using the name of the activity.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Completed">
<MemberSignature Language="C#" Value="public event EventHandler Completed;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler Completed" />
<MemberSignature Language="DocId" Value="E:System.Workflow.Activities.SequentialWorkflowActivity.Completed" />
<MemberSignature Language="VB.NET" Value="Public Custom Event Completed As EventHandler " />
<MemberSignature Language="F#" Value="member this.Completed : EventHandler " Usage="member this.Completed : System.EventHandler " />
<MemberSignature Language="C++ CLI" Value="public:
 event EventHandler ^ Completed;" />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.MergableProperty(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.MergableProperty(false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the workflow has finished.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example shows how to create a new <xref:System.Workflow.Activities.SequentialWorkflowActivity> class, and set the event handler for the <xref:System.Workflow.Activities.SequentialWorkflowActivity.Completed> event. This code example is part of the Policy SDK Sample from the DiscountPolicyWorkflow.Designer.cs file. For more information, see [Advanced Policy](https://msdn.microsoft.com/library/1ad079ee-b50b-4af4-9575-597eafc97742).
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets.vb" id="Snippet1":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CompletedEvent">
<MemberSignature Language="C#" Value="public static readonly System.Workflow.ComponentModel.DependencyProperty CompletedEvent;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Workflow.ComponentModel.DependencyProperty CompletedEvent" />
<MemberSignature Language="DocId" Value="F:System.Workflow.Activities.SequentialWorkflowActivity.CompletedEvent" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly CompletedEvent As DependencyProperty " />
<MemberSignature Language="F#" Value=" staticval mutable CompletedEvent : System.Workflow.ComponentModel.DependencyProperty" Usage="System.Workflow.Activities.SequentialWorkflowActivity.CompletedEvent" />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Workflow::ComponentModel::DependencyProperty ^ CompletedEvent;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Workflow.ComponentModel.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Represents the <see cref="T:System.Workflow.ComponentModel.DependencyProperty" /> that targets the <see cref="E:System.Workflow.Activities.SequentialWorkflowActivity.Completed" /> event.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
[!INCLUDE[DependencyPropertyRemark](~/includes/dependencypropertyremark-md.md)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DynamicUpdateCondition">
<MemberSignature Language="C#" Value="public System.Workflow.ComponentModel.ActivityCondition DynamicUpdateCondition { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Workflow.ComponentModel.ActivityCondition DynamicUpdateCondition" />
<MemberSignature Language="DocId" Value="P:System.Workflow.Activities.SequentialWorkflowActivity.DynamicUpdateCondition" />
<MemberSignature Language="VB.NET" Value="Public Property DynamicUpdateCondition As ActivityCondition" />
<MemberSignature Language="F#" Value="member this.DynamicUpdateCondition : System.Workflow.ComponentModel.ActivityCondition with get, set" Usage="System.Workflow.Activities.SequentialWorkflowActivity.DynamicUpdateCondition" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Workflow::ComponentModel::ActivityCondition ^ DynamicUpdateCondition { System::Workflow::ComponentModel::ActivityCondition ^ get(); void set(System::Workflow::ComponentModel::ActivityCondition ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Workflow.ComponentModel.ActivityCondition</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets an <see cref="T:System.Workflow.ComponentModel.ActivityCondition" /> in which dynamic updates can be made in the workflow, when overridden in a derived class.</summary>
<value>A <see cref="T:System.Workflow.ComponentModel.ActivityCondition" /> that identifies when dynamic updates can be made.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Execute">
<MemberSignature Language="C#" Value="protected override System.Workflow.ComponentModel.ActivityExecutionStatus Execute (System.Workflow.ComponentModel.ActivityExecutionContext executionContext);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance valuetype System.Workflow.ComponentModel.ActivityExecutionStatus Execute(class System.Workflow.ComponentModel.ActivityExecutionContext executionContext) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Activities.SequentialWorkflowActivity.Execute(System.Workflow.ComponentModel.ActivityExecutionContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function Execute (executionContext As ActivityExecutionContext) As ActivityExecutionStatus" />
<MemberSignature Language="F#" Value="override this.Execute : System.Workflow.ComponentModel.ActivityExecutionContext -> System.Workflow.ComponentModel.ActivityExecutionStatus" Usage="sequentialWorkflowActivity.Execute executionContext" />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::Workflow::ComponentModel::ActivityExecutionStatus Execute(System::Workflow::ComponentModel::ActivityExecutionContext ^ executionContext);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Workflow.ComponentModel.ActivityExecutionStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="executionContext" Type="System.Workflow.ComponentModel.ActivityExecutionContext" />
</Parameters>
<Docs>
<param name="executionContext">The <see cref="T:System.Workflow.ComponentModel.ActivityExecutionContext" /> associated with the <see cref="T:System.Workflow.ComponentModel.Activity" />.</param>
<summary>Runs the workflow.</summary>
<returns>The <see cref="T:System.Workflow.ComponentModel.ActivityExecutionStatus" /> at the <see cref="T:System.Workflow.Activities.SequentialWorkflowActivity" /> at the end of the requested operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Initialized">
<MemberSignature Language="C#" Value="public event EventHandler Initialized;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler Initialized" />
<MemberSignature Language="DocId" Value="E:System.Workflow.Activities.SequentialWorkflowActivity.Initialized" />
<MemberSignature Language="VB.NET" Value="Public Custom Event Initialized As EventHandler " />
<MemberSignature Language="F#" Value="member this.Initialized : EventHandler " Usage="member this.Initialized : System.EventHandler " />
<MemberSignature Language="C++ CLI" Value="public:
 event EventHandler ^ Initialized;" />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.MergableProperty(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.MergableProperty(false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the workflow is initialized.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InitializedEvent">
<MemberSignature Language="C#" Value="public static readonly System.Workflow.ComponentModel.DependencyProperty InitializedEvent;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Workflow.ComponentModel.DependencyProperty InitializedEvent" />
<MemberSignature Language="DocId" Value="F:System.Workflow.Activities.SequentialWorkflowActivity.InitializedEvent" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly InitializedEvent As DependencyProperty " />
<MemberSignature Language="F#" Value=" staticval mutable InitializedEvent : System.Workflow.ComponentModel.DependencyProperty" Usage="System.Workflow.Activities.SequentialWorkflowActivity.InitializedEvent" />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Workflow::ComponentModel::DependencyProperty ^ InitializedEvent;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Workflow.ComponentModel.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Represents the <see cref="T:System.Workflow.ComponentModel.DependencyProperty" /> that targets the <see cref="E:System.Workflow.Activities.SequentialWorkflowActivity.Initialized" /> event.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
[!INCLUDE[DependencyPropertyRemark](~/includes/dependencypropertyremark-md.md)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="OnSequenceComplete">
<MemberSignature Language="C#" Value="protected override sealed void OnSequenceComplete (System.Workflow.ComponentModel.ActivityExecutionContext executionContext);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnSequenceComplete(class System.Workflow.ComponentModel.ActivityExecutionContext executionContext) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Activities.SequentialWorkflowActivity.OnSequenceComplete(System.Workflow.ComponentModel.ActivityExecutionContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides NotOverridable Sub OnSequenceComplete (executionContext As ActivityExecutionContext)" />
<MemberSignature Language="F#" Value="override this.OnSequenceComplete : System.Workflow.ComponentModel.ActivityExecutionContext -> unit" Usage="sequentialWorkflowActivity.OnSequenceComplete executionContext" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void OnSequenceComplete(System::Workflow::ComponentModel::ActivityExecutionContext ^ executionContext);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="executionContext" Type="System.Workflow.ComponentModel.ActivityExecutionContext" />
</Parameters>
<Docs>
<param name="executionContext">The <see cref="T:System.Workflow.ComponentModel.ActivityExecutionContext" /> associated with the <see cref="T:System.Workflow.ComponentModel.Activity" />.</param>
<summary>Raises the <see cref="F:System.Workflow.Activities.SequentialWorkflowActivity.CompletedEvent" /> for the <see cref="T:System.Workflow.Activities.SequentialWorkflowActivity" />.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="executionContext" /> is a null reference (<see langword="Nothing" /> in Visual Basic).</exception>
</Docs>
</Member>
</Members>
</Type>