SubsetFunction Class

Base class for subset functions.

Inheritance Hierarchy

SystemObject
  Dundas.BI.ExtensibilityComponentBase
    Dundas.BI.Data.FunctionsFunctionDefinition
      Dundas.BI.Data.FunctionsSubsetFunction

Namespace: Dundas.BI.Data.Functions
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.4.0.1000)

Syntax

C++

Copy

public abstract class SubsetFunction : FunctionDefinition

Public MustInherit Class SubsetFunction
	Inherits FunctionDefinition

public ref class SubsetFunction abstract : public FunctionDefinition

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

The SubsetFunction type exposes the following members.

Constructors

	Name	Description
	SubsetFunction	Initializes a new instance of the SubsetFunction class

Top

Properties

	Name	Description
	AlignmentCategory	Gets the alignment option for the current function. (Inherited from FunctionDefinition.)
	CategoryId	Gets the function category ID. (Overrides FunctionDefinitionCategoryId.)
	CategoryName	Gets the function category name. (Inherited from FunctionDefinition.)
	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. (Inherited from FunctionDefinition.)
	Description	Gets or sets the object description. (Inherited from FunctionDefinition.)
	HelpUri	Gets a URI to a web page which provides documentation about the function. (Inherited from FunctionDefinition.)
	IsCommon	Gets a value indicating whether the function should appear in the list of common functions. (Inherited from FunctionDefinition.)
	IsDataInputAligned	Gets a value indicating whether the current instance requires that the data inputs are following alignment rules. (Inherited from FunctionDefinition.)
	IsDataInputHierarchyAligned	Gets a value indicating whether the current instance requires that the data inputs are aligned based on a specified hierarchy values. (Inherited from FunctionDefinition.)
	IsEnabled	Gets a value indicating whether the component is enabled. (Inherited from ComponentBase.)
	IsExplicitAlignmentRequired	Gets a value indicating whether this instance requires explicit alignment. (Inherited from FunctionDefinition.)
	Name	Gets or sets the object name. (Inherited from FunctionDefinition.)
	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. (Inherited from FunctionDefinition.)
	Settings	Gets all the current instance settings. (Inherited from FunctionDefinition.)
	Symbol	Gets the minimum 3 character string symbol for the function. (Inherited from FunctionDefinition.)

Top

Methods

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

Top

Reference

Dundas.BI.Data.Functions Namespace