ProgressCheckCancel Method

Spotfire 14.3 API Reference
Checks if the current progress operation has been canceled by the user and if so, throws a ProgressCanceledException.

Namespace:  Spotfire.Dxp.Framework.ApplicationModel
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
Copy
public abstract void CheckCancel()
Exceptions
ExceptionCondition
ProgressCanceledException If the progress has been canceled by the user through a user interface associated with the progress.
Remarks
Call this method when an operation under progress may be canceled by users through a user interface. In cases where the operation has been canceled, an exception of type ProgressCanceledException is thrown.

Note that the frequency of calls to this method affects the responsiveness of a cancel button in the progress user interface, for example in a progress dialog. It is therefore highly recommended to make calls to this method as often as possible for the cancellation to appear responsive. Never calling this method during your operation, disables users to be able to cancel the operation.

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference

Progress Class
Spotfire.Dxp.Framework.ApplicationModel Namespace