Class CalculationData

CalculationData class

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

public class CalculationData

Properties

NameDescription
CalculatedValue { get; set; }Gets or sets the calculated value for this function.
Cell { get; }Gets the Cell object where the function is in.
CellColumn { get; }Gets the column index of the cell where the function is in.
CellRow { get; }Gets the row index of the cell where the function is in.
FunctionName { get; }Gets the function name to be calculated.
ParamCount { get; }Gets the count of parameters
Workbook { get; }Gets the Workbook object where the function is in.
Worksheet { get; }Gets the Worksheet object where the function is in.

Methods

NameDescription
GetParamText(int)Gets the literal text of the parameter at given index.
GetParamValue(int)Gets the represented value object of the parameter at given index.
GetParamValueInArrayMode(int, int, int)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.

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.

Examples

[C#]

namespace Demos
{
    using Aspose.Cells;
    using System;

    public class CalculationDataDemo
    {
        public static void CalculationDataExample()
        {
            // Create a workbook
            Workbook workbook = new Workbook();
            Worksheet worksheet = workbook.Worksheets[0];

            // Add some sample data
            worksheet.Cells["A1"].PutValue(10);
            worksheet.Cells["A2"].PutValue(20);
            worksheet.Cells["A3"].PutValue(30);
            worksheet.Cells["B1"].PutValue(5);
            worksheet.Cells["B2"].PutValue(15);
            worksheet.Cells["B3"].PutValue(25);

            // Add a formula to a cell
            Cell cell = worksheet.Cells["C1"];
            cell.Formula = "=SUM(A1:A3)";

            // Calculate the formula
            workbook.CalculateFormula();



            // Save the workbook
            workbook.Save("CalculationDataExample.xlsx");
            workbook.Save("CalculationDataExample.pdf");
        }
    }
}

See Also