Methods

getCalculatedValue()

Gets or sets the calculated value for this function. 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 can be any value of those objects that can be set to a Cell(Cell.Value). And it can also be array of such kind of values, or a Range, Name, ReferredArea. Getting this property before setting will make the function be calculated by the default calculation engine of Aspose.Cells and the calculated value will be returned.

getCell()

Gets the Cell object where the function is in.

getCellColumn()

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

getCellRow()

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

getFunctionName()

Gets the function name to be calculated.

getParamCount()

Gets the count of parameters

getParamText(index) → String

Gets the literal text of the parameter at given index.

Parameter

Name Type Optional Description

index

Number

 

index of the parameter(0 based)

Returns

String literal text of the parameter

getParamValue(index) → Object

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

Parameter

Name Type Optional Description

index

Number

 

index of the parameter(0 based)

Returns

Object If the parameter is plain value, then returns the plain value. If the parameter is reference, then returns ReferredArea object. If the parameter references to multiple datasets, then returns array of objects.

getWorkbook()

Gets the Workbook object where the function is in.

getWorksheet()

Gets the Worksheet object where the function is in.

setCalculatedValue()

Gets or sets the calculated value for this function. 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 can be any value of those objects that can be set to a Cell(Cell.Value). And it can also be array of such kind of values, or a Range, Name, ReferredArea. Getting this property before setting will make the function be calculated by the default calculation engine of Aspose.Cells and the calculated value will be returned.