DataFunctionDefinition Class TIBCO Spotfire 7.6 API Reference
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
SystemObject
  Spotfire.Dxp.Data.DataFunctionsDataFunctionDefinition

Namespace: Spotfire.Dxp.Data.DataFunctions
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
Copy
[SerializableAttribute]
[PersistenceVersionAttribute(8, 0)]
public sealed class DataFunctionDefinition : ISerializable

The DataFunctionDefinition type exposes the following members.

Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to this instance.
(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
Returns a hash code for this instance.
(Overrides ObjectGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberLoad
Create a function definition from the library.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSave
Updates the function definition in the library.
Public methodSaveAs
Saves the function definition as a new item in the library.
Public methodToString
Returns a String that represents this instance.
(Overrides ObjectToString.)
Top
Properties
  NameDescription
Public propertyAllowCaching
Gets a value indicating whether caching of the result of the function is allowed or not.
Public propertyDescription
Gets the description.
Public propertyDisplayName
Gets the display name.
Public propertyFunctionName
Gets the name of the function.
Public propertyInputParameters
Gets the input parameters.
Public propertyLibraryIdentifier
Gets the identifier to the function definition as stored in the library.
Public propertyOutputParameters
Gets the output parameters.
Public propertyServiceType
Gets the type identifier for the provider responsible for executing the function.
Public propertySettings
Gets settings that are specific for the type of function used.
Top
Version Information

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference

Spotfire.Dxp.Data.DataFunctions Namespace