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 */
public boolean get_WorkerSupportsCancellation ()

/** @property */
public void set_WorkerSupportsCancellation (boolean value)

public function get WorkerSupportsCancellation () : boolean

public function set WorkerSupportsCancellation (value : boolean)

Not applicable.

Property Value

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.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions