Checks if the current progress operation has been canceled by the user
and if so, throws a ProgressCanceledException.
Namespace: Spotfire.Dxp.Framework.ApplicationModelAssembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 18.10.8513.5432 (18.10.8513.5432)
Syntax
Exceptions
Exception | Condition |
---|---|
Spotfire.Dxp.Framework.ApplicationModel ProgressCanceledException | If the progress has been canceled by the user through a user interface associated with the progress. |
Remarks
Note that the frequencey 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
See Also