com.aspose.cells

com.aspose.cells

Class CalculationData

  • java.lang.Object
    • com.aspose.cells.CalculationData
public class CalculationData 
extends java.lang.Object

Represents the required data when calculating one function, such as function name, parameters, ...etc.
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.

Property Getters/Setters Summary
java.lang.ObjectgetCalculatedValue()
void
setCalculatedValue(java.lang.Objectvalue)
           Gets or sets the calculated value for this function.
CellgetCell()
Gets the Cell object where the function is in.
intgetCellColumn()
Gets the column index of the cell where the function is in.
intgetCellRow()
Gets the row index of the cell where the function is in.
java.lang.StringgetFunctionName()
Gets the function name to be calculated.
intgetParamCount()
Gets the count of parameters
WorkbookgetWorkbook()
Gets the Workbook object where the function is in.
WorksheetgetWorksheet()
Gets the Worksheet object where the function is in.
 
Method Summary
java.lang.StringgetParamText(int index)
Gets the literal text of the parameter at given index.
java.lang.ObjectgetParamValue(int index)
Gets the represented value object of the parameter at given index.
 

    • Property Getters/Setters Detail

      • getCalculatedValue/setCalculatedValue

        public java.lang.Object getCalculatedValue() / public void setCalculatedValue(java.lang.Object value)
        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. 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 Workbook getWorkbook()
        Gets the Workbook object where the function is in.

      • getWorksheet

        public Worksheet getWorksheet()
        Gets the Worksheet object where the function is in.

      • getCellRow

        public int getCellRow()
        Gets the row index of the cell where the function is in.

      • getCellColumn

        public int getCellColumn()
        Gets the column index of the cell where the function is in.

      • getCell

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

    setCalculatedValue

    public voidsetCalculatedValue(java.lang.Objectvalue)
    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. 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.

    • Method Detail

      • 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 returns ReferredArea object. If the parameter references to multiple datasets, then returns array of objects.

      • 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