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:
property bool Cancelled {
	bool 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.

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

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft