com.aspose.gridweb

Class GridCalculationData

java.lang.Object

com.aspose.gridweb.GridCalculationData

public class GridCalculationData
extends java.lang.Object

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getCalculatedValue() Gets the calculated value for this function.
GridCell	getCell() Gets the Cell object where the function is in.
java.lang.String	getFunctionName() Gets the function name to be calculated.
int	getParamCount() Gets the count of parameters
java.lang.String	getParamText(int index) Gets the literal text of the parameter at given index.
java.lang.Object	getParamValue(int index) Gets the represented value object of the parameter at given index.
GridWorkbook	getWorkbook() Gets the Workbook object where the function is in.
GridWorksheet	getWorksheet() Gets the Workbook object where the function is in.
void	setCalculatedValue(java.lang.Object value) Sets the calculated value for this function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCalculatedValue

public java.lang.Object getCalculatedValue()

Gets the calculated value for this function.

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. 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.

setCalculatedValue

public void setCalculatedValue(java.lang.Object value)

Sets the calculated value for this function.

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. 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.

getWorkbook

public GridWorkbook getWorkbook()

Gets the Workbook object where the function is in.

getWorksheet

public GridWorksheet getWorksheet()

Gets the Workbook object where the function is in.

getCell

public GridCell getCell()

Gets the Cell object where the function is in.

getFunctionName

public java.lang.String getFunctionName()

Gets the function name to be calculated.

getParamCount

public int getParamCount()

Gets the count of parameters

getParamValue

public java.lang.Object getParamValue(int index)

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

Parameters:

index - index of the parameter(0 based)

Returns:

If the parameter is plain value, then returns the plain value. If the parameter is reference, then return ReferredArea object.

getParamText

public java.lang.String getParamText(int index)

Gets the literal text of the parameter at given index.

Parameters:

index - index of the parameter(0 based)

Returns:

literal text of the parameter