Represents a definition of an data function.
The definition describes the information needed to invoke the function and enough information to provide a user interface for specifying how the inputs and outputs should be handled. If the function definition represents a script it also contains the script definition.
The function definition provides methods to save and load the definition from the Spotfire library.
Inheritance Hierarchy
Spotfire.Dxp.Data.DataFunctionsDataFunctionDefinition
Namespace: Spotfire.Dxp.Data.DataFunctions
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(8, 0)] [ImmutableAttribute] public sealed class DataFunctionDefinition : ISerializable
The DataFunctionDefinition type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AllowCaching |
Gets a value indicating whether caching of the result of the function is allowed or not.
|
| Category |
Gets the category of the data function.
|
| Description |
Gets the description.
|
| DisplayName |
Gets the display name.
|
| FunctionName | Gets the name of the function.
|
| InputParameters |
Gets the input parameters.
|
| IsApprovedByCurrentUser |
Gets a value indicating whether this data function is approved by the current Windows user.
|
| LibraryIdentifier |
Gets the identifier to the function definition as stored in the library.
|
| OutputParameters |
Gets the output parameters.
|
| ServiceType |
Gets the type identifier for the provider responsible for executing the function.
|
| Settings |
Gets settings that are specific for the type of function used.
|
Methods
| Name | Description | |
|---|---|---|
 | Equals |
Determines whether the specified Object is equal to this instance.
(Overrides ObjectEquals(Object).) |
| GetHashCode |
Returns a hash code for this instance.
(Overrides ObjectGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
 | Load |
Create a function definition from the library.
|
| Save |
Updates the function definition in the library.
|
| SaveAs |
Saves the function definition as a new item in the library.
|
| ToString |
Returns a String that represents this instance.
(Overrides ObjectToString.) |
| WithApprovalByCurrentUserRevoked |
Creates a new DataFunctionDefinition instance that is a copy of this one, but without any approval stamp of
the current Windows user. The DataFunctionDefinition instance on which this method is invoked is not modified.
|
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
  | ISerializableGetObjectData | Implements ISerializable.
|
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