Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Cancelled Property
Collapse the table of content
Expand the table of content

AsyncCompletedEventArgs.Cancelled Property

Gets a value indicating whether an asynchronous operation has been canceled.

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

public bool Cancelled { get; }

Property Value

Type: System.Boolean
true if the background operation has been canceled; otherwise false. The default is false.

When the Cancelled property is true, the asynchronous operation was interrupted.

The client application's event-handler delegate should check the Cancelled property before accessing any properties in a class derived from AsyncCompletedEventArgs; otherwise, the property will raise an InvalidOperationException if the asynchronous operation was interrupted.

Notes to Inheritors

If you provide read-only properties in a derived class, be sure to call the RaiseExceptionIfNecessary method. This prevents clients from accessing properties that are potentially not valid due to a failure in the asynchronous operation.

The following code example demonstrates the using an AsyncOperation to track the lifetime of asynchronous operations. This code example is part of a larger example provided for the System.ComponentModel.AsyncOperationManager class.

using System;
using System.Collections;
using System.Collections.Specialized;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Globalization;
using System.Threading;
using System.Windows.Forms;


...


// This event handler updates the ListView control when the 
// PrimeNumberCalculator raises the CalculatePrimeCompleted 
// event. The ListView item is updated with the appropriate 
// outcome of the calculation: Canceled, Error, or result. 
private void primeNumberCalculator1_CalculatePrimeCompleted(
    object sender, 
    CalculatePrimeCompletedEventArgs e)
{
    Guid taskId = (Guid)e.UserState;

    if (e.Cancelled)
    {   
        string result = "Canceled";

        ListViewItem lvi = UpdateListViewItem(taskId, result);

        if (lvi != null)
        {
            lvi.BackColor = Color.Pink;
            lvi.Tag = null;
        }
    }
    else if (e.Error != null)
    {
        string result = "Error";

        ListViewItem lvi = UpdateListViewItem(taskId, result);

        if (lvi != null)
        {
            lvi.BackColor = Color.Red;
            lvi.ForeColor = Color.White;
            lvi.Tag = null;
        }
    }
    else
    {   
        bool result = e.IsPrime;

        ListViewItem lvi = UpdateListViewItem(
            taskId, 
            result, 
            e.FirstDivisor);

        if (lvi != null)
        {
            lvi.BackColor = Color.LightGray;
            lvi.Tag = null;
        }
    }
}

.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

XNA Framework

Supported in: 3.0, 2.0, 1.0

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Portable Class Library

Supported in: Portable Class Library
Show:
© 2015 Microsoft