ProgressExecuteSubtask Method (String, ProgressOperation)

 Spotfire 14.3 API Reference
Starts a new continuous subtask, that is, a subtask in which the extent of the operation is either not known or not of interest.

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 void ExecuteSubtask(
	string title,
	ProgressOperation operation
)

Parameters

title
Type: SystemString
A user-friendly representation of what the sub task performs. May not be null.
operation
Type: Spotfire.Dxp.Framework.ApplicationModelProgressOperation
The operation to execute. The operation may either be defined as an anonymous delegate or a local method wrapped in a ProgressOperation. This parameter may not be null.
Exceptions
ExceptionCondition
ArgumentNullException If either title or operation is null.
Examples
Use this method as follows:
C#
Copy
ProgressService progressService = GetService<ProgressService>();
progressService.ExecuteWithProgress("Opening File",
    delegate
    {
        // Do some work
        // ...

        ProgressService.CurrentProgress.ExecuteSubtask("Sub task",
            delegate
            {
                // Do something
                // ...

                ProgressService.CurrentProgress.CheckCancel();
            });

        // Do more work
        // ...
    }
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
ExecuteSubtask Overload
Spotfire.Dxp.Framework.ApplicationModel Namespace