CalculationData

CalculationData class

Represents the required data when calculating one function, such as function name, parameters, …etc.

class CalculationData;

Remarks

All objects provided by this class are for “read” purpose only. User should not change any data in the Workbook during the formula calculation process, Otherwise unexpected result or Exception may be caused.

Methods

Method	Description
getCalculatedValue()	Gets or sets the calculated value for this function.
setCalculatedValue(object)	Gets or sets the calculated value for this function.
getWorkbook()	Gets the Workbook object where the function is in.
getWorksheet()	Gets the Worksheet object where the function is in.
getCellRow()	Gets the row index of the cell where the function is in.
getCellColumn()	Gets the column index of the cell where the function is in.
getCell()	Gets the Cell object where the function is in.
getFunctionName()	Gets the function name to be calculated.
getParamCount()	Gets the count of parameters
getParamValue(number)	Gets the represented value object of the parameter at given index.
getParamValueInArrayMode(number, number, number)	Gets the value(s) of the parameter at given index. If the parameter is some kind of expression that needs to be calculated, then it will be calculated in array mode.
getParamText(number)	Gets the literal text of the parameter at given index.
isNull()	Checks whether the implementation object is null.

getCalculatedValue()

Gets or sets the calculated value for this function.

getCalculatedValue() : object;

Remarks

User should set this property in his custom calculation engine for those functions the engine supports, and the set value will be returned when getting this property later. The set value may be of possible types of Cell.Value, or array of such kind of values, or a Range, Name, ReferredArea. Getting this property before setting value to it will make the function be calculated by the default calculation engine of Aspose.Cells and then the calculated value will be returned(generally it should be #NAME? for user-defined functions).

setCalculatedValue(object)

Gets or sets the calculated value for this function.

setCalculatedValue(value: object) : void;

Parameters:

Parameter	Type	Description
value	object	The value to set.

Remarks

getWorkbook()

Gets the Workbook object where the function is in.

getWorkbook() : Workbook;

Returns

Workbook

getWorksheet()

Gets the Worksheet object where the function is in.

getWorksheet() : Worksheet;

Returns

Worksheet

getCellRow()

Gets the row index of the cell where the function is in.

getCellRow() : number;

getCellColumn()

Gets the column index of the cell where the function is in.

getCellColumn() : number;

getCell()

Gets the Cell object where the function is in.

getCell() : Cell;

Returns

Cell

Remarks

When calculating a formula without setting it to a cell, such as by [Worksheet.CalculateFormula(string, CalculationOptions)](../worksheet.calculateformula(string, calculationoptions)/), the formula will be calculated just like it has been set to cell A1, so both CellRow and CellColumn are 0. However, cell A1 in the worksheet may has not been instantiated. So for such kind of situation this property will be null.

getFunctionName()

Gets the function name to be calculated.

getFunctionName() : string;

getParamCount()

Gets the count of parameters

getParamCount() : number;

getParamValue(number)

Gets the represented value object of the parameter at given index.

getParamValue(index: number) : object;

Parameters:

Parameter	Type	Description
index	number	The index of the parameter(0 based)

Returns

The calculated value of the parameter.

Remarks

For one parameter:

If it is plain value, then returns the plain value itself;

If it is reference, then returns ReferredArea object;

If it references to dataset(s) with multiple values, then returns array of objects;

If it is some kind of expression that needs to be calculated, then it will be calculated in value mode and generally a single value will be returned according to current cell base. For example, if one parameter of D2’s formula is A:A+B:B, then A2+B2 will be calculated and returned. However, if this parameter has been specified as array mode (by Workbook.UpdateCustomFunctionDefinition(CustomFunctionDefinition) or FormulaParseOptions.CustomFunctionDefinition), then an array(object[][]) will be returned whose items are A1+B1,A2+B2,….

getParamValueInArrayMode(number, number, number)

Gets the value(s) of the parameter at given index. If the parameter is some kind of expression that needs to be calculated, then it will be calculated in array mode.

getParamValueInArrayMode(index: number, maxRowCount: number, maxColumnCount: number) : object[][];

Parameters:

Parameter	Type	Description
index	number	The index of the parameter(0 based)
maxRowCount	number	The row count limit for the returned array. /// If it is non-positive or greater than the actual row count, then actual row count will be used.
maxColumnCount	number	The column count limit for the returned array. /// If it is non-positive or greater than the actual row count, then actual column count will be used.

Returns

An array which contains all items represented by the specified parameter.

Remarks

For an expression that needs to be calculated, taking A:A+B:B as an example: In value mode it will be calculated to a single value according to current cell base. But in array mode, all values of A1+B1,A2+B2,A3+B3,… will be calculated and used to construct the returned array. And for such kind of situation, it is better to specify the limit for the row/column count (such as according to Cells.MaxDataRow and Cells.MaxDataColumn), otherwise the returned large array may increase memory cost with large amount of useless data.

getParamText(number)

Gets the literal text of the parameter at given index.

getParamText(index: number) : string;

Parameters:

Parameter	Type	Description
index	number	index of the parameter(0 based)

Returns

literal text of the parameter

isNull()

Checks whether the implementation object is null.

isNull() : boolean;