ProgressService.ExecuteWithProgress Method

ProgressService ExecuteWithProgress Method

TIBCO Spotfire 6.0 API Reference

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: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

public void ExecuteWithProgress(
	string title,
	string description,
	ProgressOperation operation
)

public void ExecuteWithProgress(
	string title,
	string description,
	ProgressOperation operation
)

Parameters

title: Type: System String
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: System String
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.ApplicationModel ProgressOperation
The operation to run while the progress is active.

Exceptions

Exception	Condition
System ArgumentNullException	If either titledescription, or operation is null.
Spotfire.Dxp.Framework.ApplicationModel ProgressCanceledException	If an ProgressCanceledException is thrown by the operation. This occurs when the user cancels the operation using the progress dialog.
System.Reflection TargetInvocationException	If any other (unhandled) exception is thrown by the operation.
System InvalidOperationException	If a transaction on the document is in progress.
System InvalidOperationException	If a nested call to ExecuteWithProgress is being made.

Remarks

The operation and all of its sub tasks might be run in a worker thread depending on which type of application (Professional, Web Player) that hosts the current TIBCO Spotfire instance. Any dialogs that need to be shown during the operation shall be prompted using the PromptService. The PromptService requires the dialog to be modal.

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 avaliable 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.