com.aspose.gridjs

Class GridCalculationData

java.lang.Object

com.aspose.gridjs.GridCalculationData

public class GridCalculationData
extends java.lang.Object

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

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.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getCalculatedValue() Gets the calculated value for this function.
int	getColumn() Gets the Cell Column index where the function is in.
java.lang.String	getFormula() Gets the Cell formula 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.
int	getRow() Gets the Cell Row index where the function is in.
java.lang.String	getSheetName() Gets the worksheet name where the function is in.
java.lang.String	getStringValue() Gets the Cell DisplayStringValue where the function is in.
java.lang.Object	getValue() Gets the Cell value 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.

getRow

public int getRow()

Gets the Cell Row index where the function is in.

getColumn

public int getColumn()

Gets the Cell Column index where the function is in.

getStringValue

public java.lang.String getStringValue()

Gets the Cell DisplayStringValue where the function is in.

getValue

public java.lang.Object getValue()

Gets the Cell value where the function is in.

getFormula

public java.lang.String getFormula()

Gets the Cell formula where the function is in.

getSheetName

public java.lang.String getSheetName()

Gets the worksheet name 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 - The 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 - The index of the parameter(0 based).

Returns:

The literal text of the parameter.