BackgroundWorker.IsBusy Property

Definition

Namespace:

System.ComponentModel

Assemblies:

netstandard.dll, System.ComponentModel.EventBasedAsync.dll

Source:

BackgroundWorker.cs

Gets a value indicating whether the BackgroundWorker is running an asynchronous operation.

C#

public bool IsBusy { get; }

Property Value

Boolean

true, if the BackgroundWorker is running an asynchronous operation; otherwise, false.

Examples

The following code example demonstrates how to use the IsBusy property to wait for completion of a BackgroundWorker operation. This code example is part of a larger example described in How to: Download a File in the Background.

C#

private void downloadButton_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.downloadButton.Enabled = false;

    // Once you have started the background thread you 
    // can exit the handler and the application will 
    // wait until the RunWorkerCompleted event is raised.

    // Or if you want to do something else in the main thread,
    // such as update a progress bar, you can do so in a loop 
    // while checking IsBusy to see if the background task is
    // still running.

    while (this.backgroundWorker1.IsBusy)
    {
        progressBar1.Increment(1);
        // Keep UI messages moving, so the form remains 
        // responsive during the asynchronous operation.
        Application.DoEvents();
    }
}

Remarks

The BackgroundWorker starts an asynchronous operation when you call RunWorkerAsync.

Applies to

See also

• RunWorkerCompleted
• EventArgs
• RunWorkerAsync
• How to: Run an Operation in the Background
• How to: Download a File in the Background