Class FunctionBase

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

Inheritance

System.Object

FunctionBase

ErrorType

False

FunctionWithArguments

IfFunction

IsBlank

IsErr

IsError

IsLogical

IsNA

IsNonText

IsNumber

IsRef

IsText

NA

Pi

Today

True

TypeFunction

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

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

Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public abstract class FunctionBase

Constructors

FunctionBase()

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

Declaration

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

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

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

public abstract string Name { get; }

Property Value

System.String The name.

Methods

Evaluate(FunctionEvaluationContext<RadExpression>)

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

Declaration

public RadExpression Evaluate(FunctionEvaluationContext<RadExpression> context)

Parameters

FunctionEvaluationContext<RadExpression> context 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

protected virtual RadExpression EvaluateOverride(FunctionEvaluationContext<RadExpression> context)

Parameters

FunctionEvaluationContext<RadExpression> context The context.

Returns

RadExpression Function result as RadExpression.

IsArgumentNumberValid(Int32)

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

Declaration

public bool IsArgumentNumberValid(int argumentsCount)

Parameters

System.Int32 argumentsCount The arguments count.

Returns

System.Boolean Boolean indicating whether the arguments number is valid.