WorkerSupportsCancellation Property

BackgroundWorker.WorkerSupportsCancellation Property


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

Namespace:   System.ComponentModel
Assembly:  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.

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
© 2015 Microsoft