Gets a value indicating whether this instance of the BackgroundWorker has been asked to cancel the current worker thread operation.

Namespace:  ESRI.ArcGISExplorer.Threading

Assembly:  ESRI.ArcGISExplorer (in ESRI.ArcGISExplorer.dll) Version: 2.0.0.1500 (2.0.0.1500)

Syntax

C#
public bool CancellationPending { get; }
Visual Basic (Declaration)
Public ReadOnly Property CancellationPending As Boolean

Field Value

trueTruetruetrue (True in Visual Basic) if cancellation of the worker thread operation has been requested; otherwise, falseFalsefalsefalse (False in Visual Basic).

Remarks

This property should be regularly checked within the DoWork event handler - if found to be trueTruetruetrue (True in Visual Basic) then the DoWork event handler should exit, terminating the worker thread.

This property is set to trueTruetruetrue (True in Visual Basic) by the CancelAsync()()() method being called.

See Also