BackgroundWorker.WorkerSupportsCancellation Property

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.EventBasedAsync.dll

Source:

BackgroundWorker.cs

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

Boolean

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.

See also

• CancelAsync()
• How to: Run an Operation in the Background
• How to: Download a File in the Background