方法: イベントベースの非同期パターンをサポートするコンポーネントを使用する

  • [アーティクル]

多くのコンポーネントでは、非同期的に作業を実行するオプションが提供されます。 たとえば、SoundPlayer と PictureBox コンポーネントでは、メイン スレッドが中断されることなく、実行され続ける間に、"バックグラウンドで" 音声とイメージを読み込むことができます。

イベントベースの非同期パターンの概要をサポートするクラスで非同期メソッドを使用することは、別のイベントに対して行うように、イベント ハンドラーをコンポーネントの MethodNameCompleted イベントにアタッチするのと同じくらい単純です。 MethodNameAsync メソッドを呼び出すと、MethodNameCompleted イベントが発生するまで、アプリケーションは中断されることなく実行され続けます。 イベント ハンドラーで、非同期操作が正常に完了するか、キャンセルされたかどうかを判断するには、AsyncCompletedEventArgs パラメーターを調べることができます。

イベント ハンドラーの使用に関する詳細については、「イベント ハンドラーの概要」を参照してください。

次の手順は、PictureBox コントロールの非同期イメージ読み込み機能を使用する方法について示しています。

イメージを非同期的に読み込むために PictureBox コントロールを有効にするには

  1. フォームで PictureBox コンポーネントのインスタンスを作成します。

  2. イベント ハンドラーを LoadCompleted イベントに割り当てます。

    非同期ダウンロード中に発生する可能性があるエラーをここで確認してください。 また、ここはキャンセルを確認するための場所でもあります。

    public Form1()
{
    InitializeComponent();

    this.pictureBox1.LoadCompleted +=
        new System.ComponentModel.AsyncCompletedEventHandler(this.pictureBox1_LoadCompleted);
}

    Friend WithEvents PictureBox1 As System.Windows.Forms.PictureBox

    private void pictureBox1_LoadCompleted(object sender, AsyncCompletedEventArgs e)
{
    if (e.Error != null)
    {
        MessageBox.Show(e.Error.Message, "Load Error");
    }
    else if (e.Cancelled)
    {
        MessageBox.Show("Load canceled", "Canceled");
    }
    else
    {
        MessageBox.Show("Load completed", "Completed");
    }
}

    Private Sub PictureBox1_LoadCompleted( _
    ByVal sender As System.Object, _
    ByVal e As System.ComponentModel.AsyncCompletedEventArgs) _
    Handles PictureBox1.LoadCompleted

    If (e.Error IsNot Nothing) Then
        MessageBox.Show(e.Error.Message, "Load Error")
    ElseIf e.Cancelled Then
        MessageBox.Show("Load cancelled", "Canceled")
    Else
        MessageBox.Show("Load completed", "Completed")
    End If

End Sub

  3. loadButton と cancelLoadButton と呼ばれる 2 つのボタンをフォームに追加します。 ダウンロードの開始とキャンセルを行うために、Click イベント ハンドラーを追加します。

    private void loadButton_Click(object sender, EventArgs e)
{
    // Replace with a real url.
    pictureBox1.LoadAsync("https://unsplash.com/photos/qhixfmpqN8s/download?force=true&w=1920");
}

    Private Sub loadButton_Click( _
    ByVal sender As System.Object, _
    ByVal e As System.EventArgs) _
    Handles loadButton.Click

    ' Replace with a real url.
    PictureBox1.LoadAsync("https://unsplash.com/photos/qhixfmpqN8s/download?force=true&w=1920")

End Sub

    private void cancelLoadButton_Click(object sender, EventArgs e)
{
    pictureBox1.CancelAsync();
}

    Private Sub cancelLoadButton_Click( _
    ByVal sender As System.Object, _
    ByVal e As System.EventArgs) _
    Handles cancelLoadButton.Click

    PictureBox1.CancelAsync()

End Sub

  4. アプリケーションを実行します。

    イメージのダウンロードを進めるときに、フォームを自由に移動したり、最小化や最大化を行ったりすることができます。

関連項目