ExportToolTExecuteCore Method (T, ExportResult)

Spotfire 14.3 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: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

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.

Copy

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: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

ExportToolT Class

ExecuteCore Overload

Spotfire.Dxp.Application.Tools Namespace

ExportToolAddLanguageSpecificTextSet("LST24B8ACB9_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TAddLanguageSpecificTextSet("LST24B8ACB9_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)");AddLanguageSpecificTextSet("LST24B8ACB9_2?cpp=::|nu=.");ExecuteCore Method (T, ExportResult)

Parameters

Return Value

Reference

ExportToolTExecuteCore Method (T, ExportResult)