ExportTool.ExecuteCore Method (Document, ExportResult)

ExportTool ExecuteCore Method (Document, ExportResult)

TIBCO Spotfire 7.0 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: 18.10.8513.5432 (18.10.8513.5432)

Syntax

C++

Copy to Clipboard Print

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

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

Parameters

context: Type: Spotfire.Dxp.Application Document
The document used as context.

result: Type: Spotfire.Dxp.Application.Tools ExportResult
The result container.

Return Value

Type: IEnumerable Object
An enumerable of prompt models that should be prompted on.

Examples

To report progress in this method; perform the job inside a subtask.

C++

Copy to Clipboard Print

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();
    }
}

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.0, 6.5, 6.0, 5.5, 5.0