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
           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.
functiongetParamValueInArrayMode(index, maxRowCount, maxColumnCount)
Gets the value(s) of the parameter at given index. If the parameter is some kind of expression that needs to be calculated, then it will be calculated in array mode.
 

    • 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 may be of possible types of Cell.Value, or array of such kind of values, or a Range, Name, ReferredArea. Getting this property before setting value to it will make the function be calculated by the default calculation engine of Aspose.Cells and then the calculated value will be returned(generally it should be #NAME? for user-defined functions).
      • 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.
      • 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. For one parameter:

        If it is plain value, then returns the plain value itself;

        If it is reference, then returns ReferredArea object;

        If it references to dataset(s) with multiple values, then returns array of objects;

        If it is some kind of expression that needs to be calculated, then it will be calculated in value mode and generally a single value will be returned according to current cell base. For example, if one parameter of D2's formula is A:A+B:B, then A2+B2 will be calculated and returned. However, if this parameter has been specified as array mode (by Workbook.updateCustomFunctionDefinition(com.aspose.cells.CustomFunctionDefinition) or FormulaParseOptions.CustomFunctionDefinition), then an array(object[][]) will be returned whose items are A1+B1,A2+B2,....

        Parameters:
        index: Number - The index of the parameter(0 based)
        Returns:
        The calculated value of the parameter.
      • getParamValueInArrayMode

        function getParamValueInArrayMode(index, maxRowCount, maxColumnCount)
        Gets the value(s) of the parameter at given index. If the parameter is some kind of expression that needs to be calculated, then it will be calculated in array mode. For an expression that needs to be calculated, taking A:A+B:B as an example: In value mode it will be calculated to a single value according to current cell base. But in array mode, all values of A1+B1,A2+B2,A3+B3,... will be calculated and used to construct the returned array. And for such kind of situation, it is better to specify the limit for the row/column count (such as according to Cells.MaxDataRow and Cells.MaxDataColumn), otherwise the returned large array may increase memory cost with large amount of useless data.
        Parameters:
        index: Number - The index of the parameter(0 based)
        maxRowCount: Number - The row count limit for the returned array. If it is non-positive or greater than the actual row count, then actual row count will be used.
        maxColumnCount: Number - The column count limit for the returned array. If it is non-positive or greater than the actual row count, then actual column count will be used.
        Returns:
        An array which contains all items represented by the specified parameter.
      • 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