-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
WorkflowApplicationIdleEventArgs.xml
69 lines (61 loc) · 5.26 KB
/
WorkflowApplicationIdleEventArgs.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
<Type Name="WorkflowApplicationIdleEventArgs" FullName="System.Activities.WorkflowApplicationIdleEventArgs">
<TypeSignature Language="C#" Value="public class WorkflowApplicationIdleEventArgs : System.Activities.WorkflowApplicationEventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WorkflowApplicationIdleEventArgs extends System.Activities.WorkflowApplicationEventArgs" />
<TypeSignature Language="DocId" Value="T:System.Activities.WorkflowApplicationIdleEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class WorkflowApplicationIdleEventArgs
Inherits WorkflowApplicationEventArgs" />
<TypeSignature Language="F#" Value="type WorkflowApplicationIdleEventArgs = class
 inherit WorkflowApplicationEventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class WorkflowApplicationIdleEventArgs : 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>Holds information about the workflow instance that has become idle.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example inspects the <xref:System.Activities.WorkflowApplicationIdleEventArgs> passed into the <xref:System.Activities.WorkflowApplication.Idle%2A> handler of a <xref:System.Activities.WorkflowApplication> instance. In this example the workflow going idle has one <xref:System.Activities.Bookmark> with a name of `EnterGuess`, owned by an activity named `ReadInt`. This code example is based off of [How to: Run a Workflow](/dotnet/framework/windows-workflow-foundation/how-to-run-a-workflow), which is part of the [Getting Started Tutorial [.NET Framework 4.5]](/dotnet/framework/windows-workflow-foundation/getting-started-tutorial). If the <xref:System.Activities.WorkflowApplication.Idle%2A> handler in that step is modified to contain the code from this example, the following output is displayed.
```Output
BookmarkName: EnterGuess - OwnerDisplayName: ReadInt
```
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowapplicationexample/cs/program.cs" id="Snippet2":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Bookmarks">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.ReadOnlyCollection<System.Activities.Hosting.BookmarkInfo> Bookmarks { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.ReadOnlyCollection`1<class System.Activities.Hosting.BookmarkInfo> Bookmarks" />
<MemberSignature Language="DocId" Value="P:System.Activities.WorkflowApplicationIdleEventArgs.Bookmarks" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Bookmarks As ReadOnlyCollection(Of BookmarkInfo)" />
<MemberSignature Language="F#" Value="member this.Bookmarks : System.Collections.ObjectModel.ReadOnlyCollection<System.Activities.Hosting.BookmarkInfo>" Usage="System.Activities.WorkflowApplicationIdleEventArgs.Bookmarks" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::ObjectModel::ReadOnlyCollection<System::Activities::Hosting::BookmarkInfo ^> ^ Bookmarks { System::Collections::ObjectModel::ReadOnlyCollection<System::Activities::Hosting::BookmarkInfo ^> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.ReadOnlyCollection<System.Activities.Hosting.BookmarkInfo></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the read-only collection of bookmarks for the workflow instance.</summary>
<value>A read-only collection of bookmarks.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example inspects the <xref:System.Activities.WorkflowApplicationIdleEventArgs> passed into the <xref:System.Activities.WorkflowApplication.Idle%2A> handler of a <xref:System.Activities.WorkflowApplication> instance. In this example the workflow going idle has one <xref:System.Activities.Bookmark> with a name of `EnterGuess`, owned by an activity named `ReadInt`. This code example is based off of [How to: Run a Workflow](/dotnet/framework/windows-workflow-foundation/how-to-run-a-workflow), which is part of the [Getting Started Tutorial [.NET Framework 4.5]](/dotnet/framework/windows-workflow-foundation/getting-started-tutorial). If the <xref:System.Activities.WorkflowApplication.Idle%2A> handler in that step is modified to contain the code from this example, the following output is displayed.
```Output
BookmarkName: EnterGuess - OwnerDisplayName: ReadInt
```
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowapplicationexample/cs/program.cs" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>