FunctionDefinition Class

Base class for functions.
Inheritance Hierarchy

Namespace:  Dundas.BI.Data.Functions
Assembly:  Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.3.0.1000)
Syntax
public abstract class FunctionDefinition : ComponentBase

The FunctionDefinition type exposes the following members.

Constructors
  NameDescription
Protected methodFunctionDefinition
Initializes a new instance of the FunctionDefinition class.
Top
Properties
  NameDescription
Public propertyAlignmentCategory
Gets the alignment option for the current function.
Public propertyCategoryId
Gets the function category ID.
Public propertyCategoryName
Gets the function category name.
Public propertyComponentDescription
Gets the standard component description.
(Inherited from ComponentBase.)
Public propertyComponentId
Gets the component ID.
(Inherited from ComponentBase.)
Public propertyComponentName
Gets the standard component name.
(Inherited from ComponentBase.)
Public propertyDataInputs
Gets all the data inputs for the current function.
Public propertyDescription
Gets or sets the object description.
Public propertyHelpUri
Gets a URI to a web page which provides documentation about the function.
Public propertyIsCommon
Gets a value indicating whether the function should appear in the list of common functions.
Public propertyIsDataInputAligned
Gets a value indicating whether the current instance requires that the data inputs are following alignment rules.
Public propertyIsDataInputHierarchyAligned
Gets a value indicating whether the current instance requires that the data inputs are aligned based on a specified hierarchy values.
Public propertyIsEnabled
Gets a value indicating whether the component is enabled.
(Inherited from ComponentBase.)
Public propertyIsExplicitAlignmentRequired
Gets a value indicating whether this instance requires explicit alignment.
Public propertyName
Gets or sets the object name.
Public propertyPackageId
Gets the ID of the extension package to which the component belongs.
(Inherited from ComponentBase.)
Public propertyResultDescriptors
Gets all the results for the current function.
Public propertySettings
Gets all the current instance settings.
Public propertySymbol
Gets the minimum 3 character string symbol for the function.
Top
Methods
  NameDescription
Public methodExecute
Executes the function and calculates the results.
Public methodGetDynamicResultMetadata
Gets the dynamic result metadata. This method should always be overridden when the function returns dynamic results, therefore when the number of results depends on the inputs.
Protected methodGetMetadata
Populates the function metadata by describing the data inputs, the function parameters and results.
Protected methodLocalize
Localizes the specified string using the engine localization service.
(Inherited from ComponentBase.)
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Protected methodValidateDataInputs
Validates the data inputs.
Public methodValidateFunctionSettings
Validates the function setting values against their type, valid values and allowed range. It does not validate any parameter relationships.
Public methodValidateParameters
Validates the parameters and throws if any parameter values are invalid.
Top
See Also