チュートリアル : イベントの処理

ビューの切り替え

チュートリアル : イベントの処理

すべて縮小

言語フィルタ

このページは次のバージョンについて記述しています。

Microsoft Visual Studio 2008/.NET Framework 3.5

その他のバージョンについては、以下の情報を参照してください。

Visual Basic のプログラミングガイド

チュートリアル : イベントの処理

更新 : 2007 年 11 月

このトピックは、イベントの処理方法を示す 2 番目のトピックです。最初のトピック「チュートリアル : イベントの宣言と発生」では、イベントの宣言方法と発生方法について説明しました。ここでは、最初のトピックのチュートリアルのフォームとクラスを使用して、発生したイベントを処理する方法を示します。

Widget クラスの例では、従来のイベント処理ステートメントを使用します。Visual Basic には、これ以外のイベント処理テクニックも用意されています。この例を変更して AddHandler ステートメントと Handles ステートメントを使用することもできます。

Widget クラスの PercentDone イベントを処理するには

Form1 に次のコードを記述します。
Visual Basic
Private WithEvents mWidget As Widget Private mblnCancel As Boolean
WithEvents キーワードは、変数 mWidget がオブジェクトのイベントを処理するために使用されることを指定します。オブジェクトの作成元のクラス名を指定して、オブジェクトの種類を指定します。
mWidget 変数は Form1 内で宣言します。WithEvents の変数はクラスレベルにする必要があるからです。別のクラスの場合も同様です。
変数 mblnCancel は、LongTask メソッドをキャンセルするために使用されます。

イベントを処理するコードの記述

WithEvents を使用して変数を宣言すると、クラスのコードエディタの左側のドロップダウンリストに変数名が表示されます。mWidget を選択すると、右側のドロップダウンリストに Widget クラスのイベントが表示されます。イベントを選択すると、対応するイベントプロシージャが表示されます。イベントプロシージャの名前は、先頭に mWidget およびアンダースコアが付きます。WithEvents 変数に関連付けられたイベントプロシージャの名前は、すべて先頭に変数名が付きます。

イベントを処理するには

コードエディタで、左側のドロップダウンリストの mWidget をクリックします。

右側のドロップダウンリストの PercentDone イベントをクリックします。コードエディタ内に mWidget_PercentDone イベントプロシージャが表示されます。

メモ :
新しいイベントハンドラを挿入するときにはコードエディタを使用すると便利ですが、必須ではありません。このチュートリアルでは、イベントハンドラをコード内に直接コピーした方が簡単です。

mWidget_PercentDone イベントハンドラに次のコードを追加します。
Visual Basic
Private Sub mWidget_PercentDone( _ ByVal Percent As Single, _ ByRef Cancel As Boolean _ ) Handles mWidget.PercentDone lblPercentDone.Text = CInt(100 * Percent) & "%" My.Application.DoEvents() If mblnCancel Then Cancel = True End Sub
PercentDone イベントが発生するたびに、イベントプロシージャは完了したパーセントを Label コントロールに表示します。DoEvents メソッドにより、ラベルが再描画され、ユーザーに [キャンセル] をクリックする機会が与えられます。

Button2_Click イベントハンドラに次のコードを追加します。

Visual Basic

Private Sub Button2_Click( _
    ByVal sender As Object, _
    ByVal e As System.EventArgs _
) Handles Button2.Click
    mblnCancel = True
End Sub

LongTask の実行中にユーザーが [キャンセル] をクリックした場合は、DoEvents ステートメントによってイベント処理が許可されるとすぐに、Button2_Click イベントが実行されます。クラスレベル変数 mblnCancel が True に設定され、mWidget_PercentDone イベントがこれをテストして、ByRef Cancel 引数を True に設定します。

WithEvents 変数のオブジェクトへの接続

Form1 は、Widget オブジェクトのイベントを処理するように設定されます。後は、Widget を見つけるだけです。

デザイン時に変数 WithEvents を宣言するときは、どのオブジェクトも関連付けられていません。WithEvents 変数は、他のオブジェクト変数と同じです。オブジェクトを作成し、WithEvents 変数を使用してオブジェクトへの参照を代入する必要があります。

オブジェクトを作成し、オブジェクトへの参照を代入するには

コードエディタで、左側のドロップダウンリストの [(Form1 イベント)] をクリックします。
右側のドロップダウンリストの Load イベントをクリックします。コードエディタ内に Form1_Load イベントプロシージャが表示されます。

Form1_Load イベントプロシージャに次のコードを追加して、Widget を作成します。

Visual Basic

Private Sub Form1_Load( _
    ByVal sender As System.Object, _
    ByVal e As System.EventArgs _
) Handles MyBase.Load
    mWidget = New Widget
End Sub

このコードが実行されると、Visual Basic は Widget オブジェクトを作成し、そのイベントを mWidget に関連付けられたイベントプロシージャに接続します。これ以後、Widget が PercentDone イベントを発生させるたびに、mWidget_PercentDone イベントプロシージャが実行されます。

LongTask メソッドを呼び出すには

Button1_Click イベントハンドラに次のコードを追加します。

Visual Basic

Private Sub Button1_Click( _
    ByVal sender As Object, _
    ByVal e As System.EventArgs _
) Handles Button1.Click
    mblnCancel = False
    lblPercentDone.Text = "0%"
    lblPercentDone.Refresh()
    mWidget.LongTask(12.2, 0.33)
    If Not mblnCancel Then lblPercentDone.Text = CStr(100) & "%"
End Sub

LongTask メソッドを呼び出す前に、完了したパーセントを表示するラベルを初期化する必要があります。また、メソッドをキャンセルするためのクラスレベルの Boolean フラグを False に設定する必要があります。

LongTask は、12.2 秒のタスク存続期間で呼び出されます。PercentDone イベントは、1/3 秒ごとに発生します。イベントが発生するたびに、mWidget_PercentDone イベントプロシージャが実行されます。

LongTask の実行が完了すると mblnCancel がテストされ、LongTask が正常に終了したかどうか、または mblnCancel が True に設定されたために実行が停止したかどうかが確認されます。完了したパーセントは、正常に終了したかどうかを確認する場合にだけ更新されます。

プログラムを実行するには

F5 キーを押してプロジェクトを実行モードにします。
[タスクの開始] をクリックします。PercentDone イベントが発生するたびに、タスクの完了したパーセント値でラベルが更新されます。

[キャンセル] をクリックして、タスクを停止します。[キャンセル] ボタンの外観は、クリックしてもすぐには変化しません。My.Application.DoEvents ステートメントによってイベント処理が許可されるまで、Click イベントは発生しません。

メモ :
My.Application.DoEvents メソッドは、フォームとまったく同じ方法でイベントを処理するわけではありません。たとえばこのチュートリアルでは、[キャンセル] を 2 回クリックする必要があります。フォームがイベントを直接処理するようにするには、マルチスレッドを使用します。詳細については、「Visual Basic におけるマルチスレッド」を参照してください。

メモ :

My.Application.DoEvents メソッドは、フォームとまったく同じ方法でイベントを処理するわけではありません。たとえばこのチュートリアルでは、[キャンセル] を 2 回クリックする必要があります。フォームがイベントを直接処理するようにするには、マルチスレッドを使用します。詳細については、「Visual Basic におけるマルチスレッド」を参照してください。

プログラムを実行するときに、F11 キーを押してコードを 1 行ずつ処理すると便利な場合があります。実行が LongTask に移り、PercentDone イベントが発生するたびに一時的に実行が Form1 に移るようすを明確に確認できます。

実行が Form1 のコードに戻っているときに、LongTask メソッドが再び呼び出された場合、どうなるか考えてください。最悪の場合、イベントが発生するたびに LongTask が呼び出されると、スタックオーバーフローが発生します。

新しい Widget への参照を mWidget 変数に代入すると、この mWidget 変数に異なる Widget オブジェクトのイベントを処理させることができます。実際、ボタンをクリックするたびに Button1_Click のコードを実行させることができます。

異なる Widget のイベントを処理するには

Button1_Click プロシージャの mWidget.LongTask(12.2, 0.33) という行の直前に、次のコードを追加します。
Visual Basic
mWidget = New Widget ' Create a new Widget object.

上記のコードは、ボタンがクリックされるごとに新しい Widget を作成します。LongTask メソッドが完了すると、すぐに Widget への参照が解放され、Widget は破棄されます。

WithEvents 変数には、一度に 1 つのオブジェクト参照しか保持できません。したがって、mWidget に別の Widget オブジェクトを代入すると、前の Widget オブジェクトのイベントは処理されなくなります。mWidget が、前の Widget への参照を含む唯一のオブジェクト変数である場合、オブジェクトは破棄されます。複数の Widget オブジェクトからのイベントを処理する場合は、AddHandler ステートメントを使用して、各オブジェクトからのイベントを個別に処理します。