DataFunctionDefinitionBuilder Class

Spotfire 14.2 API Reference
Responsible for building a DataFunctionDefinition.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Data.DataFunctionsDataFunctionDefinitionBuilder

Namespace:  Spotfire.Dxp.Data.DataFunctions
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
public sealed class DataFunctionDefinitionBuilder

The DataFunctionDefinitionBuilder type exposes the following members.

Constructors

  NameDescription
Public methodDataFunctionDefinitionBuilder(DataFunctionDefinition)
Initializes a new instance of the DataFunctionDefinitionBuilder class.
Public methodDataFunctionDefinitionBuilder(String, TypeIdentifier)
Initializes a new instance of the DataFunctionDefinitionBuilder class.
Top
Properties

  NameDescription
Public propertyAllowCaching
Gets or sets a value indicating whether caching of the result of the function is allowed or not.
Public propertyCategory
Gets or sets the category of the data function.
Public propertyDescription
Gets or sets the description.
Public propertyDisplayName
Gets or sets the display name.
Public propertyFunctionName
Gets or sets the function name.
Public propertyInputParameters
Gets the input parameters.
Public propertyIsValid
Gets a value indicating whether the builder contains enough information to build a data function definition or not.
Public propertyLibraryIdentifier
Gets the library identifier of the DataFunctionDefinition to be built.
Public propertyOutputParameters
Gets the output parameters.
Public propertyServiceType
Gets or sets the service type.
Public propertySettings
Gets the implementation specific settings.
Top
Methods

  NameDescription
Public methodBuild
Build the data function definition.
Public methodClearLibraryIdentifier
Clear the library identifier for this data function definition builder.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLoadCustomIcon
Loads a custom SVG icon for this data function from a file, using the file name as the name of the icon.
Public methodSetCustomIcon
Sets a custom SVG icon for this data function.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference