次の方法で共有


チュートリアル: 操作をバックグラウンドで実行する

完了に長い時間がかかる操作を実行しており、ユーザー インターフェイスで遅延が発生しないようにするにはBackgroundWorker クラスを使用して別のスレッドで操作を実行できます。

この例で使用されているコードの完全な一覧については、「方法: バックグラウンドで操作を実行する」を参照してください。

バックグラウンドで操作を実行する

  1. Visual Studio の Windows フォーム デザイナーでフォームがアクティブになっている状態で、2 つの Button コントロールをツールボックスからフォームにドラッグし、次の表に従って、ボタンの Name プロパティと Text プロパティを設定します。

    ボタン 名前 テキスト
    button1 startBtn Start
    button2 cancelBtn キャンセル
  2. ツールボックスで、 [コンポーネント] タブをクリックし、BackgroundWorker コンポーネントをフォームにドラッグします。

    backgroundWorker1 コンポーネントがコンポーネント トレイに表示されます。

  3. [プロパティ] ウィンドウで、 WorkerSupportsCancellation プロパティを trueに設定します。

  4. [プロパティ] ウィンドウで、 [イベント] ボタンをクリックし、DoWork イベントと RunWorkerCompleted イベントをダブルクリックしてイベント ハンドラーを作成します。

  5. 時間のかかるコードを、DoWork イベント ハンドラー内に挿入します。

  6. DoWorkEventArgs パラメーターの Argument プロパティから、操作に必要なパラメーターを抽出します。

  7. 計算の結果を、DoWorkEventArgsResult プロパティに代入します。

    これは、RunWorkerCompleted イベント ハンドラーで使用できるようになります。

    private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
    {
        // Do not access the form's BackgroundWorker reference directly.
        // Instead, use the reference provided by the sender parameter.
        BackgroundWorker bw = sender as BackgroundWorker;
    
        // Extract the argument.
        int arg = (int)e.Argument;
    
        // Start the time-consuming operation.
        e.Result = TimeConsumingOperation(bw, arg);
    
        // If the operation was canceled by the user,
        // set the DoWorkEventArgs.Cancel property to true.
        if (bw.CancellationPending)
        {
            e.Cancel = true;
        }
    }
    
    Private Sub backgroundWorker1_DoWork( _
    sender As Object, e As DoWorkEventArgs) _
    Handles backgroundWorker1.DoWork
    
       ' Do not access the form's BackgroundWorker reference directly.
       ' Instead, use the reference provided by the sender parameter.
       Dim bw As BackgroundWorker = CType( sender, BackgroundWorker )
       
       ' Extract the argument.
       Dim arg As Integer = Fix(e.Argument)
       
       ' Start the time-consuming operation.
       e.Result = TimeConsumingOperation(bw, arg)
       
       ' If the operation was canceled by the user, 
       ' set the DoWorkEventArgs.Cancel property to true.
       If bw.CancellationPending Then
          e.Cancel = True
       End If
    
    End Sub   
    
  8. RunWorkerCompleted イベント ハンドラーで操作の結果を取得するためのコードを挿入します。

    // This event handler demonstrates how to interpret
    // the outcome of the asynchronous operation implemented
    // in the DoWork event handler.
    private void backgroundWorker1_RunWorkerCompleted(
        object sender,
        RunWorkerCompletedEventArgs e)
    {
        if (e.Cancelled)
        {
            // The user canceled the operation.
            MessageBox.Show("Operation was canceled");
        }
        else if (e.Error != null)
        {
            // There was an error during the operation.
            string msg = String.Format("An error occurred: {0}", e.Error.Message);
            MessageBox.Show(msg);
        }
        else
        {
            // The operation completed normally.
            string msg = String.Format("Result = {0}", e.Result);
            MessageBox.Show(msg);
        }
    }
    
    ' This event handler demonstrates how to interpret 
    ' the outcome of the asynchronous operation implemented
    ' in the DoWork event handler.
    Private Sub backgroundWorker1_RunWorkerCompleted( _
    sender As Object, e As RunWorkerCompletedEventArgs) _
    Handles backgroundWorker1.RunWorkerCompleted
    
       If e.Cancelled Then
          ' The user canceled the operation.
          MessageBox.Show("Operation was canceled")
       ElseIf (e.Error IsNot Nothing) Then
          ' There was an error during the operation.
          Dim msg As String = String.Format("An error occurred: {0}", e.Error.Message)
          MessageBox.Show(msg)
       Else
          ' The operation completed normally.
          Dim msg As String = String.Format("Result = {0}", e.Result)
          MessageBox.Show(msg)
       End If
    End Sub   
    
  9. TimeConsumingOperation メソッドを実装します。

    // This method models an operation that may take a long time
    // to run. It can be cancelled, it can raise an exception,
    // or it can exit normally and return a result. These outcomes
    // are chosen randomly.
    private int TimeConsumingOperation(
        BackgroundWorker bw,
        int sleepPeriod )
    {
        int result = 0;
    
        Random rand = new Random();
    
        while (!bw.CancellationPending)
        {
            bool exit = false;
    
            switch (rand.Next(3))
            {
                // Raise an exception.
                case 0:
                {
                    throw new Exception("An error condition occurred.");
                    break;
                }
    
                // Sleep for the number of milliseconds
                // specified by the sleepPeriod parameter.
                case 1:
                {
                    Thread.Sleep(sleepPeriod);
                    break;
                }
    
                // Exit and return normally.
                case 2:
                {
                    result = 23;
                    exit = true;
                    break;
                }
    
                default:
                {
                    break;
                }
            }
    
            if( exit )
            {
                break;
            }
        }
    
        return result;
    }
    
    ' This method models an operation that may take a long time 
    ' to run. It can be cancelled, it can raise an exception,
    ' or it can exit normally and return a result. These outcomes
    ' are chosen randomly.
    Private Function TimeConsumingOperation( _
    bw As BackgroundWorker, _
    sleepPeriod As Integer) As Integer
    
       Dim result As Integer = 0
       
       Dim rand As New Random()
       
         While Not bw.CancellationPending
             Dim [exit] As Boolean = False
    
             Select Case rand.Next(3)
                 ' Raise an exception.
                 Case 0
                     Throw New Exception("An error condition occurred.")
                     Exit While
    
                     ' Sleep for the number of milliseconds
                     ' specified by the sleepPeriod parameter.
                 Case 1
                     Thread.Sleep(sleepPeriod)
                     Exit While
    
                     ' Exit and return normally.
                 Case 2
                     result = 23
                     [exit] = True
                     Exit While
    
                 Case Else
                     Exit While
             End Select
    
             If [exit] Then
                 Exit While
             End If
         End While
       
       Return result
    End Function
    
  10. Windows フォーム デザイナーで、startButton をダブルクリックして Click イベント ハンドラーを作成します。

  11. startButtonClick イベント ハンドラーの RunWorkerAsync メソッドを呼び出します。

    private void startBtn_Click(object sender, EventArgs e)
    {
        this.backgroundWorker1.RunWorkerAsync(2000);
    }
    
    Private Sub startButton_Click(ByVal sender As Object, ByVal e As EventArgs) Handles startBtn.Click
        Me.backgroundWorker1.RunWorkerAsync(2000)
    End Sub
    
  12. Windows フォーム デザイナーで、cancelButton をダブルクリックして Click イベント ハンドラーを作成します。

  13. cancelButtonClick イベント ハンドラーの CancelAsync メソッドを呼び出します。

    private void cancelBtn_Click(object sender, EventArgs e)
    {
        this.backgroundWorker1.CancelAsync();
    }
    
    Private Sub cancelButton_Click(ByVal sender As Object, ByVal e As EventArgs) Handles cancelBtn.Click
        Me.backgroundWorker1.CancelAsync()
    End Sub
    
  14. ファイルの先頭で、System.ComponentModel および System.Threading 名前空間をインポートします。

    using System;
    using System.ComponentModel;
    using System.Drawing;
    using System.Threading;
    using System.Windows.Forms;
    
    Imports System.ComponentModel
    Imports System.Drawing
    Imports System.Threading
    Imports System.Windows.Forms
    
  15. F6 キーを押してソリューションをビルドした後、Ctrl+F5 キーを押して、アプリケーションをデバッガーの外部で実行します。

    Note

    F5 キーを押して、アプリケーションをデバッガー内で実行すると、TimeConsumingOperation メソッドで発生した例外がキャッチされ、デバッガーによって表示されます。 デバッガーの外部でアプリケーションを実行した場合は、BackgroundWorker によって例外が処理され、RunWorkerCompletedEventArgsError プロパティ内にキャッシュされます。

  16. [開始] ボタンをクリックして非同期操作を実行した後、 [キャンセル] ボタンをクリックして、実行中の非同期操作を停止します。

    各操作の結果は、MessageBox に表示されます。

次のステップ

関連項目