ExportToolTExecuteCore Method (T, ExportResult)

TIBCO Spotfire 11.4 API Reference
Implement this method to perform tool specific logic. This method will always be executed as a top-level progress operation.

Namespace:  Spotfire.Dxp.Application.Tools
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 51.0.16121.3915 (51.0.16121.3915)
Syntax

C#
protected abstract IEnumerable<Object> ExecuteCore(
	T context,
	ExportResult result
)

Parameters

context
Type: T
The document node used as context.
result
Type: Spotfire.Dxp.Application.ToolsExportResult
The result container.

Return Value

Type: IEnumerableObject
An enumerable of prompt models that should be prompted on.
Examples

To report progress in this method; perform the job inside a subtask.
C#
using (ProgressService.CurrentProgress.BeginSubtask(
   "Performing export",
   stepCount,
   "Step {0} of {1}"))
{
   // Perform subtask
   for (int i = 0; i < stepCount; i++)
   {
       // Do something
       // ...

       ProgressService.CurrentProgress.TryReportProgress();
       ProgressService.CurrentProgress.CheckCancel();
   }
}
Version Information

Supported in: 11.4, 11.3, 11.2, 11.1, 11.0, 10.10, 7.11
See Also

Reference