Export (0) Print
Expand All

BackgroundWorker.CancellationPending Property

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

Namespace:  System.ComponentModel
Assemblies:   System.ComponentModel.EventBasedAsync (in System.ComponentModel.EventBasedAsync.dll)
  System (in System.dll)

public bool CancellationPending { 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.

// Abort the operation if the user has canceled. 
// Note that a call to CancelAsync may have set  
// CancellationPending to true just after the 
// last invocation of this method exits, so this  
// code will not have the opportunity to set the  
// DoWorkEventArgs.Cancel flag to true. This means 
// that RunWorkerCompletedEventArgs.Cancelled will 
// not be set to true in your RunWorkerCompleted 
// event handler. This is a race condition. 

if (worker.CancellationPending)
{   
    e.Cancel = true;
}
else
{   
    if (n < 2)
    {   
        result = 1;
    }
    else
    {   
        result = ComputeFibonacci(n - 1, worker, e) + 
                 ComputeFibonacci(n - 2, worker, e);
    }

    // Report progress as a percentage of the total task. 
    int percentComplete = 
        (int)((float)n / (float)numberToCompute * 100);
    if (percentComplete > highestPercentageReached)
    {
        highestPercentageReached = percentComplete;
        worker.ReportProgress(percentComplete);
    }
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft