WorkItemHandlerTItem Delegate

 Spotfire 14.3 API Reference
Delegate for handling processed work items. The handler must call ReturnItem when it is finished with the work item.

Namespace:  Spotfire.Dxp.Framework.Threading
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
Copy
public delegate void WorkItemHandler<TItem>(
	TItem workItem
)
where TItem : WorkItem

Parameters

workItem
Type: TItem
Processed work item.

Type Parameters

TItem
Work item type.
Examples
The following example shows how ReturnItem can be used to synchronize with the application thread.
C#
Copy
WorkItemHandler<WorkItem> workItemHandler = 
    delegate(WorkItem workItem)
    {
        AnalysisServices.GetService<ApplicationThread>().InvokeAsynchronously(delegate()
        {
            try
            {
                if (workItem.IsResultValid && !workItem.IsCanceled)
                {
                    // do something to the document.
                }
            }
            finally
            {
                // Tell threading framework that your work item handler is done.
                workItem.ReturnItem();
            }

        });
     };
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
See Also

Reference

Spotfire.Dxp.Framework.Threading Namespace
WorkItemPushResultHandlerTItem(WorkItemHandlerTItem)