ExportToolExecuteCore Method (Document, ExportResult) TIBCO Spotfire 7.12 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: 30.0.11525.4184 (30.0.11525.4184)
Syntax

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

Parameters

context
Type: Spotfire.Dxp.ApplicationDocument
The document 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: 7.9, 7.8, 7.7, 7.6, 7.5, 7.0
See Also

Reference