BackgroundWorker.WorkerSupportsCancellation Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets a value indicating whether the BackgroundWorker supports asynchronous cancellation.
public:
property bool WorkerSupportsCancellation { bool get(); void set(bool value); };
public bool WorkerSupportsCancellation { get; set; }
member this.WorkerSupportsCancellation : bool with get, set
Public Property WorkerSupportsCancellation As Boolean
Property Value
true
if the BackgroundWorker supports cancellation; otherwise false
. The default is false
.
Remarks
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.