WorkflowApplicationIdleEventArgs Class

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Holds information about the workflow instance that has become idle.

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

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

public ref class WorkflowApplicationIdleEventArgs : WorkflowApplicationEventArgs

NameDescription
System_CAPS_pubpropertyBookmarks

Gets the read-only collection of bookmarks for the workflow instance.

System_CAPS_pubpropertyInstanceId

The unique identifier of the workflow instance.(Inherited from WorkflowApplicationEventArgs.)

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetInstanceExtensions<T>()

Gets the collection of extensions of the specified type.(Inherited from WorkflowApplicationEventArgs.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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 [.NET Framework 4.5]. 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
Available since 4.0

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

Return to top
Show: