Marks the start of a new subtask.
Namespace: Spotfire.Dxp.Framework.ApplicationModel
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 66.0.19621.1485 (66.0.19621.1485)
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
Exception | Condition |
---|---|
ArgumentNullException | If title is null. |
Remarks
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
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: 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also