BackgroundWorker.CancellationPending Property

 

Gets a value indicating whether the application has requested cancellation of a background operation.

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

[<BrowsableAttribute(false)>]
member CancellationPending : bool with get

Property Value

Type: System.Boolean

true if the application has requested cancellation of a background operation; otherwise, false. The default is false.

If CancellationPending is true, then the CancelAsync method has been called on the BackgroundWorker.

This property is meant for use by the worker thread, which should periodically check CancellationPending and abort the background operation when it is set to true.

The following code example demonstrates the use of the CancellationPending property to query a BackgroundWorker about its cancellation state. This code example is part of a larger example provided for the BackgroundWorker class.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: