GridCalculationData

Inheritance: java.lang.Object

public class GridCalculationData

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.

Methods

MethodDescription
equals(Object arg0)
getCalculatedValue()Gets the calculated value for this function.
getClass()
getColumn()Gets the Cell Column index where the function is in.
getFormula()Gets the Cell formula where the function is in.
getFunctionName()Gets the function name to be calculated.
getParamCount()Gets the count of parameters .
getParamText(int index)Gets the literal text of the parameter at given index.
getParamValue(int index)Gets the represented value object of the parameter at given index.
getRow()Gets the Cell Row index where the function is in.
getSheetName()Gets the worksheet name where the function is in.
getStringValue()Gets the Cell DisplayStringValue where the function is in.
getValue()Gets the Cell value where the function is in.
hashCode()
notify()
notifyAll()
setCalculatedValue(Object value)Sets the calculated value for this function.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

getCalculatedValue()

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

Returns: java.lang.Object

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getColumn()

public int getColumn()

Gets the Cell Column index where the function is in.

Returns: int

getFormula()

public String getFormula()

Gets the Cell formula where the function is in.

Returns: java.lang.String

getFunctionName()

public String getFunctionName()

Gets the function name to be calculated.

Returns: java.lang.String

getParamCount()

public int getParamCount()

Gets the count of parameters .

Returns: int

getParamText(int index)

public String getParamText(int index)

Gets the literal text of the parameter at given index.

Parameters:

ParameterTypeDescription
indexintThe index of the parameter(0 based).

Returns: java.lang.String - The literal text of the parameter.

getParamValue(int index)

public Object getParamValue(int index)

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

Parameters:

ParameterTypeDescription
indexintThe index of the parameter(0 based).

Returns: java.lang.Object - If the parameter is plain value, then returns the plain value. If the parameter is reference, then return ReferredArea object.

getRow()

public int getRow()

Gets the Cell Row index where the function is in.

Returns: int

getSheetName()

public String getSheetName()

Gets the worksheet name where the function is in.

Returns: java.lang.String

getStringValue()

public String getStringValue()

Gets the Cell DisplayStringValue where the function is in.

Returns: java.lang.String

getValue()

public Object getValue()

Gets the Cell value where the function is in.

Returns: java.lang.Object

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setCalculatedValue(Object value)

public void setCalculatedValue(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.

Parameters:

ParameterTypeDescription
valuejava.lang.Object

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int