チュートリアル: イベントの宣言と発生 (Visual Basic)

  • [アーティクル]

このチュートリアルでは、Widget というクラスのイベントを宣言および発生させる方法を説明します。ここでの手順が完了したら、関連トピックの「チュートリアル: イベントの処理 (Visual Basic)」を参照してください。このトピックでは、Widget オブジェクトのイベントを使用して、アプリケーションのステータス情報を提供する方法を説明しています。

ウィジェット クラス

ここでは Widget クラスが既にあると仮定します。Widget クラスには、実行に時間がかかるメソッドが 1 つあるので、アプリケーションに完了のインジケーターを用意することにします。

Widget オブジェクトに、完了した割合を示すダイアログ ボックスを表示させることもできますが、ここでは、Widget クラスを使用するすべてのプロジェクトでダイアログ ボックスを表示する処理を行います。オブジェクトの目的がフォームやダイアログ ボックスを制御することでない場合、オブジェクト設計の原則は、オブジェクトを使用するアプリケーションにユーザー インターフェイスを処理させることです。

Widget の目的は他のタスクを実行することです。したがって、PercentDone イベントを追加して、Widget のメソッドを呼び出すプロシージャにイベントの処理と更新状態の表示を実行させる方が適切です。PercentDone イベントは、タスクをキャンセルするしくみも提供できます。

このトピックのコード例を作成するには

  1. Visual Basic の新しい Windows アプリケーション プロジェクトを開き、Form1 という名前のフォームを作成します。

  2. Form1 に、2 つのボタンと 1 つのラベルを追加します。

  3. 次の表のとおりにオブジェクトに名前を付けます。

    Object

    プロパティ

    設定

    Button1

    Text

    Start Task

    Button2

    Text

    [キャンセル]

    Label

    (Name), Text

    lblPercentDone, 0

  4. [プロジェクト] メニューの [クラスの追加] を選択し、プロジェクトに Widget.vb というクラスを追加します。

ウィジェット クラスのイベントを宣言するには

  • Event キーワードを使って Widget クラス内にイベントを宣言します。イベントは ByVal および ByRef 引数を受け取ることができます。Widget の PercentDone イベントの例を示します。

    Public Event PercentDone(ByVal Percent As Single, 
                         ByRef Cancel As Boolean)

呼び出し元のオブジェクトが PercentDone イベントを受け取るとき、Percent 引数には完了したタスクの割合が含まれています。Cancel 引数を True に設定すると、イベントを発生させるメソッドをキャンセルできます。

[!メモ]

イベントの引数は、プロシージャの引数と同様に宣言できます。ただし、イベントに対して Optional 引数や ParamArray 引数は指定できず、イベントには戻り値がありません。

Widget クラスの LongTask メソッドによって、PercentDone イベントが発生します。LongTask は 2 つの引数を受け取ります。1 つはメソッドが動作し続ける時間を表し、もう 1 つは LongTask が一時停止して PercentDone イベントを発生させるまでの最小の時間間隔を表します。

PercentDone イベントを発生させるには

  1. このクラスによって使用される Timer プロパティへのアクセスを簡単にするために、クラス モジュールの宣言セクションの先頭で、Class Widget ステートメントの上に Imports ステートメントを追加します。

    Imports Microsoft.VisualBasic.DateAndTime

  2. Widget クラスに次のコードを追加します。

    Public Sub LongTask(ByVal Duration As Single, 
                    ByVal MinimumInterval As Single)
    Dim Threshold As Single
    Dim Start As Single
    Dim blnCancel As Boolean

    ' The Timer property of the DateAndTime object returns the seconds
    ' and milliseconds that have passed since midnight.
    Start = CSng(Timer)
    Threshold = MinimumInterval

    Do While CSng(Timer) < (Start + Duration)
        ' In a real application, some unit of work would
        ' be done here each time through the loop.
        If CSng(Timer) > (Start + Threshold) Then
            RaiseEvent PercentDone( 
            Threshold / Duration, blnCancel)
            ' Check to see if the operation was canceled.
            If blnCancel Then Exit Sub
            Threshold = Threshold + MinimumInterval
        End If
    Loop
End Sub

アプリケーションで LongTask メソッドを呼び出すと、Widget クラスは PercentDone イベントを MinimumInterval 秒間隔で発生させます。イベントが返されると、LongTask は Cancel 引数が True に設定されたかどうかを確認します。

ここで、次の点に注意してください。簡略化のために、LongTask プロシージャでは、タスクにかかる時間があらかじめわかっているとします。実際には、このような場合はほとんどありません。タスクを均等なサイズのチャンクに分割することは難しい場合があり、ユーザーにとって最も重要なことは、処理が進行中であることを知らされるまでの時間である場合も多くあります。

このサンプルに別の欠点があります。Timer プロパティは、深夜 0 時からの経過時間を秒単位で返します。したがって、アプリケーションが 0 時直前に開始された場合、アプリケーションは正しく動作しなくなります。時間を慎重に測定するには、このような境界条件を考慮に入れるか、Now などのプロパティを使用して問題が発生するのを避けます。

これで Widget クラスからイベントを発生できるようになったので、次のチュートリアルに進むことができます。「チュートリアル: イベントの処理 (Visual Basic)」では、WithEvents を使用して PercentDone イベントにイベント ハンドラーを関連付ける方法を示します。

参照

処理手順

チュートリアル: イベントの処理 (Visual Basic)

関連項目

Timer

Now

その他の技術情報

イベント (Visual Basic)