Class
FunctionBase

Abstract base for all spreadsheet functions, defining evaluation logic, argument rules, and metadata for use in formula expressions.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Expressions.Functions

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition
public abstract class FunctionBase

Inheritance: objectFunctionBase

Derived Classes: ErrorTypeFalseFunctionWithArgumentsIfFunctionIsBlankIsErrIsErrorIsLogicalIsNAIsNonTextIsNumberIsRefIsTextNAPiTodayTrueTypeFunction

Constructors

FunctionBase()

Initializes a new function base instance, ready for evaluation in spreadsheet expressions.

Declaration

cs-api-definition
protected FunctionBase()

Properties

ArgumentConversionRules

Specifies how arguments are converted before evaluation, with a default of standard number function conversions including boolean-to-number mapping.

Declaration

cs-api-definition
public virtual ArgumentConversionRules ArgumentConversionRules { get; }

Property Value

ArgumentConversionRules

The argument conversion rules.

FunctionInfo

Provides metadata describing the function's category, required and optional arguments, and documentation for help systems.

Declaration

cs-api-definition
public abstract FunctionInfo FunctionInfo { get; }

Property Value

FunctionInfo

The function info.

Name

Returns the unique function name used in formulas to invoke this function.

Declaration

cs-api-definition
public abstract string Name { get; }

Property Value

string

The name.

Methods

Evaluate(FunctionEvaluationContext<RadExpression>)

Evaluates the function using the provided evaluation context and returns the result as an expression.

Declaration

cs-api-definition
public RadExpression Evaluate(FunctionEvaluationContext<RadExpression> context)

Parameters

context

FunctionEvaluationContext<RadExpression>

The context.

Returns

RadExpression

Function result as RadExpression.

EvaluateOverride(FunctionEvaluationContext<RadExpression>)

Performs the function-specific evaluation logic; override in derived classes to implement custom calculation behavior.

Declaration

cs-api-definition
protected virtual RadExpression EvaluateOverride(FunctionEvaluationContext<RadExpression> context)

Parameters

context

FunctionEvaluationContext<RadExpression>

The context.

Returns

RadExpression

Function result as RadExpression.

IsArgumentNumberValid(int)

Validates that the argument count falls within the acceptable range for this function, accounting for required and optional parameters and repetition rules.

Declaration

cs-api-definition
public bool IsArgumentNumberValid(int argumentsCount)

Parameters

argumentsCount

int

The arguments count.

Returns

bool

Boolean indicating whether the arguments number is valid.