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
Assembly:  System (in System.dll)

public function get Cancelled () : boolean

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.

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

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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Compact Framework

Supported in: 3.5

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

© 2015 Microsoft