WorkDispatcherTItemExecuteSynchronously Method

Spotfire 14.3 API Reference
Executes the item synchronously. This method is suitable when forced to execute items one by one and access the result synchronously.

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 void ExecuteSynchronously(
	TItem workItem,
	WorkItemHandler<TItem> resultHandler
)

Parameters

workItem
Type: TItem
The work item.
resultHandler
Type: Spotfire.Dxp.Framework.ThreadingWorkItemHandlerTItem
The result handler.
Exceptions
ExceptionCondition
InvalidOperationException Thrown if the item already has been added to a dispatcher, including this dispatcher.
Remarks
  • Access to the processed workItem shall be made in the resultHandler. The handler may be run on any thread. Since it is a work item handler, the work item can be passed to the application thread asynchronously as long as M:WorkItem.ReturnItem is not called. After that, the work item may have been disposed.
  • Different from AddFirst(TItem) and AddLast(TItem), instance equal work items cannot be added twice.
This method cannot be called during a transaction.
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

WorkDispatcherTItem Class
Spotfire.Dxp.Framework.Threading Namespace
Spotfire.Dxp.Framework.ThreadingWorkItemHandlerTItem