BackgroundWorker.WorkerReportsProgress Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets or sets a value that indicates whether the BackgroundWorker can report progress updates.

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

Syntax

'Declaration
Public Property WorkerReportsProgress As Boolean
public bool WorkerReportsProgress { get; set; }

Property Value

Type: System.Boolean
true if the BackgroundWorker supports progress updates; otherwise false. The default is false.

Remarks

Set the WorkerReportsProgress property to true if you want the BackgroundWorker to support progress updates. When this property is true, user code can call the ReportProgress method to raise the ProgressChanged event.

When this property is false, calling the ReportProgress method will cause an InvalidOperationException.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.