BackgroundWorker.IsBusy プロパティ

.NET Framework クラス ライブラリ リファレンス

BackgroundWorker.IsBusy プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

BackgroundWorker が非同期操作を実行中かどうかを示す値を取得します。

名前空間: System.ComponentModel
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public ReadOnly Property
 IsBusy As Boolean

Visual Basic (使用法)

Dim instance As BackgroundWorker
Dim value As Boolean

value = instance.IsBusy

C#

public bool IsBusy { get;
 }

C++

public:
property bool IsBusy {
    bool get ();
}

J#

/** @property */
public boolean get_IsBusy ()

JScript

public function get IsBusy
 () : boolean

プロパティ値
BackgroundWorker が非同期操作を実行中の場合は true。それ以外の場合は false。

解説

RunWorkerAsync を呼び出すと、BackgroundWorker は非同期操作を開始します。

使用例

IsBusy プロパティを使用して、BackgroundWorker 操作の完了を待機する方法を次のコード例に示します。次のコード例は、「方法 : バックグラウンドでファイルをダウンロードする」で示されている例の一部です。

Visual Basic

Private Sub dowloadButton_Click( _
ByVal sender As Object,
 _
ByVal e As EventArgs) _
Handles dowloadButton.Click

    ' Start the download operation in the background.
    Me.backgroundWorker1.RunWorkerAsync()

    ' Disable the button for the duration of the download.
    Me.dowloadButton.Enabled = False

    ' Wait for the BackgroundWorker to finish the download.
    While Me.backgroundWorker1.IsBusy
        ' Keep UI messages moving, so the form remains 
        ' responsive during the asynchronous operation.
        Application.DoEvents()
    End While

    ' The download is done, so enable the button.
    Me.dowloadButton.Enabled = True
End Sub

C#

private void dowloadButton_Click(object sender,
 EventArgs e)
{
    // Start the download operation in the background.
    this.backgroundWorker1.RunWorkerAsync();

    // Disable the button for the duration of the download.
    this.dowloadButton.Enabled = false;

    // Wait for the BackgroundWorker to finish the download.
    while (this.backgroundWorker1.IsBusy)
    {
        // Keep UI messages moving, so the form remains 
        // responsive during the asynchronous operation.
        Application.DoEvents();
    }

    // The download is done, so enable the button.
    this.dowloadButton.Enabled = true;
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
BackgroundWorker クラス
BackgroundWorker メンバ
System.ComponentModel 名前空間
RunWorkerCompleted
EventArgs
RunWorkerAsync
その他の技術情報
方法 : バックグラウンドで操作を実行する
方法 : バックグラウンドでファイルをダウンロードする