ProgressExecuteSubtask Method (String) TIBCO Spotfire 7.6 API Reference
Marks the start of a new subtask.

Namespace: Spotfire.Dxp.Framework.ApplicationModel
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax

C#
public void ExecuteSubtask(
	string title
)

Parameters

title
Type: SystemString
A user-friendly representation of what the sub task performs. May not be null.
Exceptions

ExceptionCondition
ArgumentNullException If title is null.
Remarks

Use this method when you wish to inline the code of the subtask in the code of its parent (being another subtask or a top-level operation).

The extent of a subtask created through a call to this method is from the point of the method call to a point where either a new subtask is created through a call to this method or the parent subtask ends.

Examples

Use this method as follows:
C#
ProgressService progressService = GetService<ProgressService>();
progressService.ExecuteWithProgress("Opening File",
    delegate
    {
        // Do some work
        // ...
        ProgressService.CurrentProgress.CheckCancel();

        // Mark the start of a new subtask, but inline the code
        ProgressService.CurrentProgress.ExecuteSubtask("Doing this");
        // Do more work
        // ...
        ProgressService.CurrentProgress.CheckCancel();

        ProgressService.CurrentProgress.ExecuteSubtask("Doing that");
        // Do more work
        // ...
        ProgressService.CurrentProgress.CheckCancel();
    }
Version Information

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference