WorkflowEventArgs クラス

定義

名前空間:

System.Workflow.Runtime

アセンブリ:

System.Workflow.Runtime.dll

注意事項

The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*

ワークフロー イベントにデータを提供します。

public ref class WorkflowEventArgs : EventArgs

[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public class WorkflowEventArgs : EventArgs

[<System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>]
type WorkflowEventArgs = class
    inherit EventArgs

Public Class WorkflowEventArgs
Inherits EventArgs

継承

Object

EventArgs

WorkflowEventArgs

派生

System.Workflow.Runtime.WorkflowCompletedEventArgs

System.Workflow.Runtime.WorkflowSuspendedEventArgs

System.Workflow.Runtime.WorkflowTerminatedEventArgs

属性

ObsoleteAttribute

例

次のコード例は、イベント ハンドラー メソッドを呼び出すときに WorkflowInstance プロパティを使用して WorkflowInstance オブジェクトを取得する方法を示しています。 WorkflowIdled イベントが発生すると、この例で定義されている OnWorkflowIdled メソッドが呼び出されます。 このメソッドは、WorkflowInstance プロパティを使用してアイドル状態のワークフローを特定し、GetWorkflowQueueData メソッドを呼び出してキューに登録されているワークフロー インスタンスの項目のコレクションを取得します。 コードはコレクション全体を取得するまで繰り返され、ワークフローをアイドル状態にしたイベントを待機しているアクティビティを特定します。 その後、EnqueueItem メソッドとイベント キュー アイテムの名前を使用して、ワークフロー キューに例外を送信します。

このコード例は、Program.cs ファイルに含まれている、ワークフローのキャンセルを示す SDK サンプルの一部です。 詳細については、「 ワークフローのキャンセル」を参照してください。

static void OnWorkflowIdled(object sender, WorkflowEventArgs e)
{
    WorkflowInstance workflow = e.WorkflowInstance;

    Console.WriteLine("\n...waiting for 3 seconds... \n");
    Thread.Sleep(3000);

    // what activity is blocking the workflow
    ReadOnlyCollection<WorkflowQueueInfo> wqi = workflow.GetWorkflowQueueData();
    foreach (WorkflowQueueInfo q in wqi)
    {
        EventQueueName eq = q.QueueName as EventQueueName;
        if (eq != null)
        {
            // get activity that is waiting for event
            ReadOnlyCollection<string> blockedActivity = q.SubscribedActivityNames;
            Console.WriteLine("Host: Workflow is blocked on " + blockedActivity[0]);

            // this event is never going to arrive eg. employee left the company
            // lets send an exception to this queue
            // it will either be handled by exception handler that was modeled in workflow
            // or the runtime will unwind running compensation handlers and exit the workflow
            Console.WriteLine("Host: This event is not going to arrive");
            Console.WriteLine("Host: Cancel workflow with unhandled exception");
            workflow.EnqueueItem(q.QueueName, new Exception("ExitWorkflowException"), null, null);
        }
    }
}

Shared Sub OnWorkflowIdled(ByVal sender As Object, ByVal e As WorkflowEventArgs)
    Dim workflow As WorkflowInstance = e.WorkflowInstance

    Console.WriteLine(vbCrLf + "...waiting for 3 seconds... " + vbCrLf)
    Thread.Sleep(3000)

    ' what activity is blocking the workflow
    Dim wqi As ReadOnlyCollection(Of WorkflowQueueInfo) = workflow.GetWorkflowQueueData()
    For Each q As WorkflowQueueInfo In wqi

        Dim eq As EventQueueName = TryCast(q.QueueName, EventQueueName)

        If eq IsNot Nothing Then
            ' get activity that is waiting for event
            Dim blockedActivity As ReadOnlyCollection(Of String) = q.SubscribedActivityNames
            Console.WriteLine("Host: Workflow is blocked on " + blockedActivity(0))

            ' this event is never going to arrive eg. employee left the company
            ' lets send an exception to this queue
            ' it will either be handled by exception handler that was modeled in workflow
            ' or the runtime will unwind running compensation handlers and exit the workflow
            Console.WriteLine("Host: This event is not going to arrive")
            Console.WriteLine("Host: Cancel workflow with unhandled exception")
            workflow.EnqueueItem(q.QueueName, New Exception("ExitWorkflowException"), Nothing, Nothing)
        End If
    Next
End Sub

注釈

注意

ここでは、廃止された型と名前空間について説明します。 詳細については、「.NET 4.5 での Windows Workflow Foundation の新機能」を参照してください。

ワークフロー イベントは、ワークフロー インスタンスに関連付けられます。 WorkflowEventArgs は、ワークフロー イベントに関連付けられた WorkflowInstance を格納します。 WorkflowEventArgs、または WorkflowEventArgs クラスから派生したオブジェクトは、WorkflowRuntime クラスでのすべてのワークフロー イベントにデータを提供します。 WorkflowEventArgs は、WorkflowCompletedEventArgs、WorkflowSuspendedEventArgs、および WorkflowTerminatedEventArgs の基本クラスです。

プロパティ

WorkflowInstance

古い. ワークフロー イベントに関連付けられたワークフロー インスタンスを取得します。

メソッド

Equals(Object)	古い. 指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	古い. 既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	古い. 現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	古い. 現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	古い. 現在のオブジェクトを表す文字列を返します。 (継承元 Object)

こちらもご覧ください

• ワークフローの取り消し