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 (26.2.0.1000)

Syntax

public abstract class FunctionDefinition : ComponentBase

Public MustInherit Class FunctionDefinition
	Inherits ComponentBase

public ref class FunctionDefinition abstract : public ComponentBase

[<AbstractClassAttribute>]
type FunctionDefinition = 
    class
        inherit ComponentBase
    end

The FunctionDefinition type exposes the following members.

Constructors

	Name	Description
	FunctionDefinition	Initializes a new instance of the FunctionDefinition class.

Properties

	Name	Description
	AlignmentCategory	Gets the alignment option for the current function.
	CategoryId	Gets the function category ID.
	CategoryName	Gets the function category name.
	ComponentDescription	Gets the standard component description. (Inherited from ComponentBase)
	ComponentId	Gets the component ID. (Inherited from ComponentBase)
	ComponentName	Gets the standard component name. (Inherited from ComponentBase)
	DataInputs	Gets all the data inputs for the current function.
	Description	Gets or sets the object description.
	HelpUri	Gets a URI to a web page which provides documentation about the function.
	IsCommon	Gets a value indicating whether the function should appear in the list of common functions.
	IsDataInputAligned	Gets a value indicating whether the current instance requires that the data inputs are following alignment rules.
	IsDataInputHierarchyAligned	Gets a value indicating whether the current instance requires that the data inputs are aligned based on a specified hierarchy values.
	IsEnabled	Gets a value indicating whether the component is enabled. (Inherited from ComponentBase)
	IsExplicitAlignmentRequired	Gets a value indicating whether this instance requires explicit alignment.
	Name	Gets or sets the object name.
	PackageId	Gets the ID of the extension package to which the component belongs. (Inherited from ComponentBase)
	ResultDescriptors	Gets all the results for the current function.
	Settings	Gets all the current instance settings.
	Symbol	Gets the minimum 3 character string symbol for the function.

Methods

	Name	Description
	Execute	Executes the function and calculates the results.
	GetDynamicResultMetadata	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.
	GetMetadata	Populates the function metadata by describing the data inputs, the function parameters and results.
	Localize	Localizes the specified string using the engine localization service. (Inherited from ComponentBase)
	ToString	Returns a string that represents the current object. (Overrides ObjectToString)
	ValidateDataInputs	Validates the data inputs.
	ValidateFunctionSettings	Validates the function setting values against their type, valid values and allowed range. It does not validate any parameter relationships.
	ValidateParameters	Validates the parameters and throws if any parameter values are invalid.