.NET Framework Class Library
BackgroundWorker..::.ProgressChanged Event

Occurs when ReportProgress is called.

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)
Syntax

Visual Basic (Declaration)
Public Event ProgressChanged As ProgressChangedEventHandler
Visual Basic (Usage)
Dim instance As BackgroundWorker
Dim handler As ProgressChangedEventHandler

AddHandler instance.ProgressChanged, handler
C#
public event ProgressChangedEventHandler ProgressChanged
Visual C++
public:
 event ProgressChangedEventHandler^ ProgressChanged {
    void add (ProgressChangedEventHandler^ value);
    void remove (ProgressChangedEventHandler^ value);
}
JScript
JScript does not support events.
Remarks

This event is raised when you call the ReportProgress method.

For more information about handling events, see Consuming Events.

Examples

The following code example demonstrates the use of the ProgressChanged event to report the progress of an asynchronous operation to the user. This code example is part of a larger example provided for the BackgroundWorker class.

Visual Basic
' This event handler updates the progress bar.
Private Sub backgroundWorker1_ProgressChanged( _
ByVal sender As Object, ByVal e As ProgressChangedEventArgs) _
Handles backgroundWorker1.ProgressChanged

    Me.progressBar1.Value = e.ProgressPercentage

End Sub
C#
// This event handler updates the progress bar.
private void backgroundWorker1_ProgressChanged(object sender,
    ProgressChangedEventArgs e)
{
    this.progressBar1.Value = e.ProgressPercentage;
}
Visual C++
// This event handler updates the progress bar.
void backgroundWorker1_ProgressChanged( Object^ /*sender*/, ProgressChangedEventArgs^ e )
{
   this->progressBar1->Value = e->ProgressPercentage;
}
Platforms

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Other Resources

Tags :


Page view tracker