Represents an execution of a data function defined from a DataFunctionDefinition.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Data.DataFunctionsDataFunction
Namespace: Spotfire.Dxp.Data.DataFunctions
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 30.0.10915.3380 (30.0.10915.3380)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(6, 0)] public sealed class DataFunction : DocumentNode, INamable
The DataFunction type exposes the following members.
Methods
Name | Description | |
---|---|---|
![]() | Execute |
Asynchronously executes the data function.
|
![]() | Execute(DataFunctionCompletionCallback) |
Asynchronously executes the data function with a callback when the execution has been finished.
There is no guarantee regarding timing when the function will be executed and when it has finished executing.
|
![]() | ExecuteSynchronously |
Updates the function synchronously.
|
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | SynchronizeWithLibrary |
Synchronize the function definition with the function definition stored in the library.
|
![]() | ToString |
Returns a String that represents this instance.
(Overrides ObjectToString.) |
Properties
Name | Description | |
---|---|---|
![]() | Context |
Gets the context of this node.
(Inherited from DocumentNode.) |
![]() | DataFunctionDefinition |
Gets or sets the data function definition.
|
![]() | Inputs |
Gets the inputs of the function.
|
![]() | IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) |
![]() | Name | Gets or sets the name of the function.
|
![]() | NeedsRefresh |
Gets a value indicating whether the data function needs to be refreshed.
|
![]() | Outputs | Gets the outputs of the function.
|
![]() | Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
![]() | UpdateBehavior | Gets or sets the update behavior.
|
![]() | Visible |
Gets or sets a value indicating whether the function is visible in the UI or not.
|
Explicit Interface Implementations
Name | Description | |
---|---|---|
![]() ![]() | IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) |
![]() ![]() | INodeContextGetAncestorT |
Implements GetAncestorT.
(Inherited from DocumentNode.) |
![]() ![]() | INodeContextGetServiceT |
Implements GetServiceT.
(Inherited from DocumentNode.) |
![]() ![]() | INodeContextIsDescendantOf |
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.) |
![]() ![]() | ITransactionsBeginAggregatedTransaction |
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.) |
![]() ![]() | ITransactionsExecuteInvisibleTransaction |
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.) |
![]() ![]() | ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) |
![]() ![]() | ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Remarks
Instances of this class are created in the DataFunctionCollection on the DataManager.
Version Information
See Also