BackgroundWorker.WorkerSupportsCancellation Property

Updated: January 2010

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.

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Date

History

Reason

January 2010

Update ReportProgress to mention that it is an asynchronous call.

Customer feedback.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft