/
TerminateActivity.xml
250 lines (227 loc) · 15.8 KB
/
TerminateActivity.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
<Type Name="TerminateActivity" FullName="System.Workflow.ComponentModel.TerminateActivity">
<TypeSignature Language="C#" Value="public sealed class TerminateActivity : System.Workflow.ComponentModel.Activity" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit TerminateActivity extends System.Workflow.ComponentModel.Activity" />
<TypeSignature Language="DocId" Value="T:System.Workflow.ComponentModel.TerminateActivity" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class TerminateActivity
Inherits Activity" />
<TypeSignature Language="F#" Value="type TerminateActivity = class
 inherit Activity" />
<TypeSignature Language="C++ CLI" Value="public ref class TerminateActivity sealed : System::Workflow::ComponentModel::Activity" />
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Workflow.ComponentModel.Activity</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Designer(typeof(System.Workflow.ComponentModel.Design.TerminateDesigner), typeof(System.ComponentModel.Design.IDesigner))]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Designer(typeof(System.Workflow.ComponentModel.Design.TerminateDesigner), typeof(System.ComponentModel.Design.IDesigner))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.ToolboxItem(typeof(System.Workflow.ComponentModel.Design.ActivityToolboxItem))]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.ToolboxItem(typeof(System.Workflow.ComponentModel.Design.ActivityToolboxItem))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Drawing.ToolboxBitmap(typeof(System.Workflow.ComponentModel.TerminateActivity), "Resources.Terminate.png")]</AttributeName>
<AttributeName Language="F#">[<System.Drawing.ToolboxBitmap(typeof(System.Workflow.ComponentModel.TerminateActivity), "Resources.Terminate.png")>]</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>Terminates the running workflow instance when an abnormal situation occurs. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
> [!NOTE]
> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]
<xref:System.Workflow.ComponentModel.TerminateActivity> immediately ends the execution of the current workflow instance. Unlike a suspended workflow instance, a terminated workflow instance can never be resumed.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TerminateActivity ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.ComponentModel.TerminateActivity.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 TerminateActivity();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</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.ComponentModel.TerminateActivity" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows initial property values for an instance of the <xref:System.Workflow.ComponentModel.TerminateActivity> class.
|Property|Value|
|--------------|-----------|
|<xref:System.Workflow.ComponentModel.TerminateActivity.Error%2A>|null (`Nothing` in Visual Basic).|
## Examples
This example illustrates using the constructor for a <xref:System.Workflow.ComponentModel.TerminateActivity>, and other things discussed elsewhere within this type.
This code example is part of the Suspend and Terminate SDK sample and is from the SuspendAndTerminateWorkflow.Designer.cs file. For more information, see [Using Suspend and Terminate](https://msdn.microsoft.com/library/f4dffa58-d01e-44fb-b5a1-3b283d2c4517).
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet173":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet173":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TerminateActivity (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.ComponentModel.TerminateActivity.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String)" />
<MemberSignature Language="F#" Value="new System.Workflow.ComponentModel.TerminateActivity : string -> System.Workflow.ComponentModel.TerminateActivity" Usage="new System.Workflow.ComponentModel.TerminateActivity name" />
<MemberSignature Language="C++ CLI" Value="public:
 TerminateActivity(System::String ^ name);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</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.ComponentModel.TerminateActivity" /> class using the name of the activity.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Error">
<MemberSignature Language="C#" Value="public string Error { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Error" />
<MemberSignature Language="DocId" Value="P:System.Workflow.ComponentModel.TerminateActivity.Error" />
<MemberSignature Language="VB.NET" Value="Public Property Error As String" />
<MemberSignature Language="F#" Value="member this.Error : string with get, set" Usage="System.Workflow.ComponentModel.TerminateActivity.Error" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Error { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Browsable(true)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Browsable(true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.MergableProperty(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.MergableProperty(false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets an error message to report to administrators, providing the reason for termination.</summary>
<value>An error message that provides the reason for the workflow instance termination. The default value is <see langword="null" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If this property is set when the activity is in runtime mode (the <xref:System.Workflow.ComponentModel.DependencyObject.DesignMode%2A> property is set to `false`) a <xref:System.Data.ReadOnlyException> is thrown.
Propagation of this error message is determined by the host (the instance manager or the persistence provider).
## Examples
The following example demonstrates setting the Error property. This example is from the Suspend and Terminate SDK sample. For more information, see [Suspend and Terminate Sample](https://msdn.microsoft.com/library/f4dffa58-d01e-44fb-b5a1-3b283d2c4517).
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet176":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet176":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ErrorProperty">
<MemberSignature Language="C#" Value="public static readonly System.Workflow.ComponentModel.DependencyProperty ErrorProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Workflow.ComponentModel.DependencyProperty ErrorProperty" />
<MemberSignature Language="DocId" Value="F:System.Workflow.ComponentModel.TerminateActivity.ErrorProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly ErrorProperty As DependencyProperty " />
<MemberSignature Language="F#" Value=" staticval mutable ErrorProperty : System.Workflow.ComponentModel.DependencyProperty" Usage="System.Workflow.ComponentModel.TerminateActivity.ErrorProperty" />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Workflow::ComponentModel::DependencyProperty ^ ErrorProperty;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</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="P:System.Workflow.ComponentModel.TerminateActivity.Error" /> property.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
This example illustrates initializing the <xref:System.Workflow.ComponentModel.TerminateActivity.Error%2A> property for a <xref:System.Workflow.ComponentModel.TerminateActivity>, and other things discussed elsewhere within this type.
This code example is part of the Suspend and Terminate SDK sample and is from the SuspendAndTerminateWorkflow.Designer.cs file. For more information, see [Using Suspend and Terminate](https://msdn.microsoft.com/library/f4dffa58-d01e-44fb-b5a1-3b283d2c4517).
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets11.cs" id="Snippet173":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets11.vb" id="Snippet173":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Execute">
<MemberSignature Language="C#" Value="protected internal override sealed System.Workflow.ComponentModel.ActivityExecutionStatus Execute (System.Workflow.ComponentModel.ActivityExecutionContext executionContext);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance valuetype System.Workflow.ComponentModel.ActivityExecutionStatus Execute(class System.Workflow.ComponentModel.ActivityExecutionContext executionContext) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.ComponentModel.TerminateActivity.Execute(System.Workflow.ComponentModel.ActivityExecutionContext)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides NotOverridable Function Execute (executionContext As ActivityExecutionContext) As ActivityExecutionStatus" />
<MemberSignature Language="F#" Value="override this.Execute : System.Workflow.ComponentModel.ActivityExecutionContext -> System.Workflow.ComponentModel.ActivityExecutionStatus" Usage="terminateActivity.Execute executionContext" />
<MemberSignature Language="C++ CLI" Value="protected public:
 override System::Workflow::ComponentModel::ActivityExecutionStatus Execute(System::Workflow::ComponentModel::ActivityExecutionContext ^ executionContext);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</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">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="protected internal override void Initialize (IServiceProvider provider);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance void Initialize(class System.IServiceProvider provider) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.ComponentModel.TerminateActivity.Initialize(System.IServiceProvider)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides Sub Initialize (provider As IServiceProvider)" />
<MemberSignature Language="F#" Value="override this.Initialize : IServiceProvider -> unit" Usage="terminateActivity.Initialize provider" />
<MemberSignature Language="C++ CLI" Value="protected public:
 override void Initialize(IServiceProvider ^ provider);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.ComponentModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="provider" Type="System.IServiceProvider" />
</Parameters>
<Docs>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>