Creates a new Progress object and executes the given
top-level operation in the context of that
progress.
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#
public void ExecuteWithProgress( string title, string description, ProgressOperation operation )
Parameters
- title
- Type: SystemString
A user-friendly title for the progress. The title will be shown as the title of the progress. The title may not be null. - description
- Type: SystemString
A user-friendly description of what the operation performs. The description is shown in the first line of the progress. The description may not be null. - operation
- Type: Spotfire.Dxp.Framework.ApplicationModelProgressOperation
The operation to run while the progress is active.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | If either titledescription, or operation is null. |
| ProgressCanceledException | If an ProgressCanceledException is thrown by the operation. This occurs when the user cancels the operation using the progress dialog. |
| TargetInvocationException | If any other (unhandled) exception is thrown by the operation. |
| InvalidOperationException | If a transaction on the document is in progress. |
| InvalidOperationException | If a nested call to ExecuteWithProgress is being made. |
Remarks
Note that a call to this method is synchronous, that is, the call will not return until the operation and all of its sub tasks have finished, or if the user cancels the operation, or if an unhandled exception causes the operation to be canceled.
The created Progress object is available through the static property CurrentProgress.
This method may be called on a background thread created by the threading framework in which case a background progress will be created.
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