-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
WorkflowApplicationAbortedEventArgs.xml
77 lines (65 loc) · 4.61 KB
/
WorkflowApplicationAbortedEventArgs.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
<Type Name="WorkflowApplicationAbortedEventArgs" FullName="System.Activities.WorkflowApplicationAbortedEventArgs">
<TypeSignature Language="C#" Value="public class WorkflowApplicationAbortedEventArgs : System.Activities.WorkflowApplicationEventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WorkflowApplicationAbortedEventArgs extends System.Activities.WorkflowApplicationEventArgs" />
<TypeSignature Language="DocId" Value="T:System.Activities.WorkflowApplicationAbortedEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class WorkflowApplicationAbortedEventArgs
Inherits WorkflowApplicationEventArgs" />
<TypeSignature Language="F#" Value="type WorkflowApplicationAbortedEventArgs = class
 inherit WorkflowApplicationEventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class WorkflowApplicationAbortedEventArgs : System::Activities::WorkflowApplicationEventArgs" />
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Activities.WorkflowApplicationEventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides data about an aborted workflow instance.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When a workflow hosted by a <xref:System.Activities.WorkflowApplication> is aborted, the <xref:System.Activities.WorkflowApplication.Aborted%2A> handler is invoked and the <xref:System.Activities.WorkflowApplication.Completed%2A> handler is not invoked.
## Examples
The following code example inspects the <xref:System.Activities.WorkflowApplicationAbortedEventArgs> passed into the <xref:System.Activities.WorkflowApplication.Aborted%2A> handler of a <xref:System.Activities.WorkflowApplication> instance and displays information about why workflow was aborted.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowapplicationexample/cs/program.cs" id="Snippet5":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Reason">
<MemberSignature Language="C#" Value="public Exception Reason { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Exception Reason" />
<MemberSignature Language="DocId" Value="P:System.Activities.WorkflowApplicationAbortedEventArgs.Reason" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Reason As Exception" />
<MemberSignature Language="F#" Value="member this.Reason : Exception" Usage="System.Activities.WorkflowApplicationAbortedEventArgs.Reason" />
<MemberSignature Language="C++ CLI" Value="public:
 property Exception ^ Reason { Exception ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Exception</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the exception that provides information about why the workflow instance was aborted.</summary>
<value>The exception that provides information about why the workflow instance was aborted.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When a workflow hosted by a <xref:System.Activities.WorkflowApplication> is aborted, the <xref:System.Activities.WorkflowApplication.Aborted%2A> handler is invoked and the <xref:System.Activities.WorkflowApplication.Completed%2A> handler is not invoked.
## Examples
The following code example inspects the <xref:System.Activities.WorkflowApplicationAbortedEventArgs> passed into the <xref:System.Activities.WorkflowApplication.Aborted%2A> handler of a <xref:System.Activities.WorkflowApplication> instance and displays information about why workflow was aborted.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowapplicationexample/cs/program.cs" id="Snippet5":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>