BackgroundWorker.WorkerReportsProgress Property

Definition

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

C#
public bool WorkerReportsProgress { get; set; }

Property Value

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.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1
UWP 10.0

See also