Progress.ExecuteSubtask Method (String, ProgressOperation)

Progress ExecuteSubtask Method (String, ProgressOperation)

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

Syntax

C++

Copy to Clipboard Print

public void ExecuteSubtask(
	string title,
	ProgressOperation operation
)

public void ExecuteSubtask(
	string title,
	ProgressOperation operation
)

Parameters

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

operation: Type: Spotfire.Dxp.Framework.ApplicationModel ProgressOperation
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

Exception	Condition
System ArgumentNullException	If either title or operation is null.

Examples

Use this method as follows:

C++

Copy to Clipboard Print

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 
        // ...
    }

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 
        // ...
    }