aspose.cells

aspose.cells

Class CalculationData

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
functiongetCalculatedValue()
function
setCalculatedValue(value)
           Gets or sets the calculated value for this function.
functiongetCell()
Gets the Cell object where the function is in.
functiongetCellColumn()
Gets the column index of the cell where the function is in.
functiongetCellRow()
Gets the row index of the cell where the function is in.
functiongetFunctionName()
Gets the function name to be calculated.
functiongetParamCount()
Gets the count of parameters
functiongetWorkbook()
Gets the Workbook object where the function is in.
functiongetWorksheet()
Gets the Worksheet object where the function is in.
 
Method Summary
functiongetParamText(index)
Gets the literal text of the parameter at given index.
functiongetParamValue(index)
Gets the represented value object of the parameter at given index.
 

    • Property Getters/Setters Detail

      • getCalculatedValue/setCalculatedValue : Object 

        function getCalculatedValue() / function setCalculatedValue(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 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.

      • getWorkbook : Workbook 

        function getWorkbook()
        Gets the Workbook object where the function is in.

      • getWorksheet : Worksheet 

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

      • getCellRow : Number 

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

      • getCellColumn : Number 

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

      • getCell : Cell 

        function getCell()
        Gets the Cell object where the function is in.

      • getFunctionName : String 

        function getFunctionName()
        Gets the function name to be calculated.

      • getParamCount : Number 

        function getParamCount()
        Gets the count of parameters

    • Method Detail

      • getParamValue

        function getParamValue(index)
        Gets the represented value object of the parameter at given index.
        Parameters:
        index: Number - 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

        function getParamText(index)
        Gets the literal text of the parameter at given index.
        Parameters:
        index: Number - index of the parameter(0 based)
        Returns:
        literal text of the parameter