AsyncCompletedEventArgs::Cancelled Property
Gets a value indicating whether an asynchronous operation has been canceled.
Assembly: System (in System.dll)
Property Value
Type: System::Booleantrue 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 InheritorsIf 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.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.