BackgroundWorker.WorkerSupportsCancellation Property

Gets or sets a value indicating whether the BackgroundWorker supports asynchronous cancellation.

Namespace:  System.ComponentModel
Assemblies:   System.ComponentModel.EventBasedAsync (in System.ComponentModel.EventBasedAsync.dll)
  System (in System.dll)

public bool WorkerSupportsCancellation { get; set; }

Property Value

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

Set the WorkerSupportsCancellation property to true if you want the BackgroundWorker to support cancellation. When this property is true, you can call the CancelAsync method to interrupt a background operation.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft