Represents the input and result for a value in a virtual column.
Inheritance Hierarchy
Spotfire.Dxp.Framework.ThreadingWorkItem
Spotfire.Dxp.Data.VirtualColumnsVirtualValueRequest
Namespace: Spotfire.Dxp.Data.VirtualColumns
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
public sealed class VirtualValueRequest : WorkItem, IDataPropertyContainer, IDataPropertiesAccessor
The VirtualValueRequest type exposes the following members.
Methods
Name | Description | |
---|---|---|
Dispose | Frees up resources.
(Inherited from WorkItem.) | |
Dispose(Boolean) | Override this method to release unmanaged and - optionally - managed resources.
(Inherited from WorkItem.) | |
Equals |
Determines whether the specified obj is the same instance as the current work item.
(Inherited from WorkItem.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type.
(Inherited from WorkItem.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
PushResultHandlerTItem |
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.
(Inherited from WorkItem.) | |
ReadModelTModel |
Allows reading the associated worker model in a thread-safe way.
(Inherited from WorkItem.) | |
ReturnItem | 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.
(Inherited from WorkItem.) | |
SetEmptyResult |
Sets the result value of this request to an empty value.
| |
SetErrorResult | Obsolete.
Sets the result value of this request to an error value, with
the provided error message. The error message may not be null
or an empty string.
| |
SetImmutableResult |
Sets the immutable result.
(Inherited from WorkItem.) | |
SetTransientEmptyResult |
Sets the result value of this request to an empty value. Unlike SetEmptyResult it will
be forgotten by the cache over time enabling new requests. This method is thus intended
for temporary errors such as network failures etc.
| |
SetValidResult |
Sets the result value of this request to a valid value.
|
Properties
Name | Description | |
---|---|---|
HasImmutableResult |
Gets a value indicating whether this instance has immutable result.
(Inherited from WorkItem.) | |
ImmutableResult |
Gets the immutable result.
(Inherited from WorkItem.) | |
InputValues |
The data values to compute the result value for the current request from. These values
are provided from the inputs of the virtual column identified by the external id, and more generally the properties,
of this request. The values are ordered in the same order as the inputs were given in the input collection.
If one of the inputs have been deleted an invalid value will occur in its place.
| |
IsCanceled | Returns true if the work item has been canceled.
(Inherited from WorkItem.) | |
IsResultValid | 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.
(Inherited from WorkItem.) | |
ModelGeneration | 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.
(Inherited from WorkItem.) | |
Properties |
Gets the properties of the container that the result value is produced for.
| |
Tag | Gets or sets a tag object. The tag object can be used to associate
information with the work item.
(Inherited from WorkItem.) |
Version Information
See Also