Table of Contents

TXlsFile.EvaluateUserDefinedFunction Method

Evaluates a custom function you have added earlier with TExcelFile.AddUserDefinedFunction. You will not normally need to call this method, but it could be used for testing. If the function has not been added with TExcelFile.AddUserDefinedFunction, this method will return TFlxFormulaErrorValue.ErrName.

Syntax

Unit: FlexCel.XlsAdapter

function TXlsFile.EvaluateUserDefinedFunction(const functionName: string; const arguments: TUdfEventArgs; const parameters: TArray<TFormulaValue>): TFormulaValue; override;

Parameters

<-> Parameter Type Description
const functionName string Function you want to evaluate.
const arguments TUdfEventArgs Extra arguments you can use to evaluate the formula.
const parameters TArray<​TFormula​Value> Parameters for the formula.

Returns

The result of evaluating the formula. It might be a string, a double, a boolean, a TFlxFormulaError or an Array.

See also