TUserDefinedFunction.TryGetDoubleList Method
Tries to retrieve a list of double arguments from the parameters, starting at parameter startParam.
Use this method for functions that accept a range of numeric values as an entry. (for example =Sum(a1:a10))
Syntax
Unit: FlexCel.Core
function TUserDefinedFunction.TryGetDoubleList(const Xls: TExcelFile; const parameters: TArray<TFormulaValue>; startParam: Integer; endParam: Integer; const agg: IUserDefinedFunctionAggregator; out Err: TFlxFormulaErrorValue): Boolean;
Parameters
| <-> |
Parameter |
Type |
Description |
| const |
Xls |
TExcelFile |
ExcelFile used to read the parameter when it is a cell reference. |
| const |
parameters |
TArray<TFormulaValue> |
The parameters passed to the function. |
|
startParam |
Integer |
First parameter we want to evaluate. |
|
endParam |
Integer |
Last parameter we want to evaluate. If < 0, it will evaluate all parameters from startParam to parameters.Length |
| const |
agg |
IUserDefinedFunctionAggregator |
A class descending from TUserDefinedFunctionAggregator that will process the values for every entry in the range. |
| out |
Err |
TFlxFormulaErrorValue |
Value of the error when converting the parameter. If TryGetDouble returns true (there was no error), this value is undefined. |
See also