BackgroundWorker.ReportProgress Method (Int32, Object)


Raises the ProgressChanged event.

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

member ReportProgress : 
        percentProgress:int *
        userState:Object -> unit


Type: System.Int32

The percentage, from 0 to 100, of the background operation that is complete.

Type: System.Object

The state object passed to RunWorkerAsync.

Exception Condition

The WorkerReportsProgress property is set to false.

If you need the background operation to report on its progress, you can call the ReportProgress method to raise the ProgressChanged event. The WorkerReportsProgress property value must true, or ReportProgress will throw an InvalidOperationException.

It is up to you to implement a meaningful way of measuring your background operation's progress as a percentage of the total task completed.

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

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top