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 (26.2.0.1000)
Syntax
Copy
public abstract class SubsetFunction : FunctionDefinition

The SubsetFunction type exposes the following members.

Constructors
 NameDescription
Protected methodSubsetFunctionInitializes a new instance of the SubsetFunction class
Top
Properties
 NameDescription
Public propertyAlignmentCategory Gets the alignment option for the current function.
(Inherited from FunctionDefinition)
Public propertyCategoryId Gets the function category ID.
(Overrides FunctionDefinitionCategoryId)
Public propertyCategoryName Gets the function category name.
(Inherited from FunctionDefinition)
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.
(Inherited from FunctionDefinition)
Public propertyDescription Gets or sets the object description.
(Inherited from FunctionDefinition)
Public propertyHelpUri Gets a URI to a web page which provides documentation about the function.
(Inherited from FunctionDefinition)
Public propertyIsCommon Gets a value indicating whether the function should appear in the list of common functions.
(Inherited from FunctionDefinition)
Public propertyIsDataInputAligned Gets a value indicating whether the current instance requires that the data inputs are following alignment rules.
(Inherited from FunctionDefinition)
Public propertyIsDataInputHierarchyAligned Gets a value indicating whether the current instance requires that the data inputs are aligned based on a specified hierarchy values.
(Inherited from FunctionDefinition)
Public propertyIsEnabledGets a value indicating whether the component is enabled.
(Inherited from ComponentBase)
Public propertyIsExplicitAlignmentRequired Gets a value indicating whether this instance requires explicit alignment.
(Inherited from FunctionDefinition)
Public propertyName Gets or sets the object name.
(Inherited from FunctionDefinition)
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.
(Inherited from FunctionDefinition)
Public propertySettings Gets all the current instance settings.
(Inherited from FunctionDefinition)
Public propertySymbol Gets the minimum 3 character string symbol for the function.
(Inherited from FunctionDefinition)
Top
Methods
 NameDescription
Public methodExecute Executes the function and calculates the results.
(Inherited from FunctionDefinition)
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.
(Inherited from FunctionDefinition)
Protected methodGetMetadata Populates the function metadata by describing the data inputs, the function settings and the results.
(Overrides FunctionDefinitionGetMetadata(IListInputDescriptor, IListComponentSetting, IListResultDescriptor))
Protected methodGetSubsetMetadata Populates the function metadata by describing the data inputs and the function settings.
Protected methodLocalize Localizes the specified string using the engine localization service.
(Inherited from ComponentBase)
Public methodToStringReturns a string that represents the current object.
(Inherited from FunctionDefinition)
Protected methodValidateDataInputs Validates the data inputs.
(Inherited from FunctionDefinition)
Public methodValidateFunctionSettings Validates the function setting values against their type, valid values and allowed range. It does not validate any parameter relationships.
(Inherited from FunctionDefinition)
Public methodValidateParameters Validates the parameters and throws if any parameter values are invalid.
(Inherited from FunctionDefinition)
Top
See Also