Export (0) Print
Expand All

WorkflowApplicationIdleEventArgs Class

Holds information about the workflow instance that has become idle.

System.Object
  System.EventArgs
    System.Activities.WorkflowApplicationEventArgs
      System.Activities.WorkflowApplicationIdleEventArgs

Namespace:  System.Activities
Assembly:  System.Activities (in System.Activities.dll)

'Declaration
Public Class WorkflowApplicationIdleEventArgs _
	Inherits WorkflowApplicationEventArgs

The WorkflowApplicationIdleEventArgs type exposes the following members.

  NameDescription
Public propertyBookmarksGets the read-only collection of bookmarks for the workflow instance.
Public propertyInstanceIdThe unique identifier of the workflow instance. (Inherited from WorkflowApplicationEventArgs.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetInstanceExtensions(Of T)Gets the collection of extensions of the specified type. (Inherited from WorkflowApplicationEventArgs.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The following code example inspects the WorkflowApplicationIdleEventArgs passed into the Idle handler of a WorkflowApplication instance. In this example the workflow going idle has one Bookmark with a name of EnterGuess, owned by an activity named ReadInt. This code example is based off of How to: Run a Workflow, which is part of the Getting Started Tutorial. If the Idle handler in that step is modified to contain the code from this example, the following output is displayed.

BookmarkName: EnterGuess - OwnerDisplayName: ReadInt
wfApp.Idle = delegate(WorkflowApplicationIdleEventArgs e)
{
    foreach (BookmarkInfo info in e.Bookmarks)
    {
        Console.WriteLine("BookmarkName: {0} - OwnerDisplayName: {1}",
            info.BookmarkName, info.OwnerDisplayName);
    }

    idleEvent.Set();
};

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft