WorkItem Class

Spotfire 14.3 API Reference
Base class for work items. Inherit from this class to declare custom worker input and result properties.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.ThreadingWorkItem
    Spotfire.Dxp.Data.VirtualColumnsVirtualValueRequest

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#
public abstract class WorkItem : IDisposable

The WorkItem type exposes the following members.

Constructors

  NameDescription
Protected methodWorkItem
Creates a new instance.
Top
Properties

  NameDescription
Public propertyHasImmutableResult
Gets a value indicating whether this instance has immutable result.
Public propertyImmutableResult
Gets the immutable result.
Public propertyIsCanceled
Returns true if the work item has been canceled.
Public propertyIsResultValid
Returns true if the work item result is valid in the live document. This will be false if the worker model changed after the work item was added to the dispatcher.
Public propertyModelGeneration
Gets the associated worker model generation. This can be used by the worker to cache information based on the worker model state. Should be avoided whenever possible. Caching should instead be handled via the caching behavior, the model key and item key functions of the worker factory.
Public propertyTag
Gets or sets a tag object. The tag object can be used to associate information with the work item.
Top
Methods

  NameDescription
Public methodDispose
Frees up resources.
Protected methodDispose(Boolean)
Override this method to release unmanaged and - optionally - managed resources.
Public methodEquals
Determines whether the specified obj is the same instance as the current work item.
(Overrides ObjectEquals(Object).)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Overrides ObjectGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPushResultHandlerTItem
Adds a result handler to the top of the stack of result handlers. The handler must call ReturnItem when it is finished with the work item.
Public methodReadModelTModel
Allows reading the associated worker model in a thread-safe way.
Public methodReturnItem
Signals that a worker or result handler is finished with the work item. The method then passes the work item to the next handler in the stack.
Public methodSetImmutableResult
Sets the immutable result.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
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