.NET Framework Class Library
BackgroundWorker..::.WorkerSupportsCancellation Property

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

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)
Syntax

Visual Basic (Declaration)
Public Property WorkerSupportsCancellation As Boolean
Visual Basic (Usage)
Dim instance As BackgroundWorker
Dim value As Boolean

value = instance.WorkerSupportsCancellation

instance.WorkerSupportsCancellation = value
C#
public bool WorkerSupportsCancellation { get; set; }
Visual C++
public:
property bool WorkerSupportsCancellation {
    bool get ();
    void set (bool value);
}
JScript
public function get WorkerSupportsCancellation () : boolean
public function set WorkerSupportsCancellation (value : boolean)

Property Value

Type: System..::.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.

Platforms

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Other Resources

Tags :


Page view tracker