Class CalculationData
Namespace: Aspose.Cells
Assembly: Aspose.Cells.dll (25.2.0)
Represents the required data when calculating one function, such as function name, parameters, …etc.
public class CalculationDataInheritance
Inherited Members
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
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.
Properties
CalculatedValue
Gets or sets the calculated value for this function.
public object CalculatedValue { get; set; }Property Value
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 later. The set value may be of possible types of Aspose.Cells.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).
Cell
Gets the Cell object where the function is in.
public Cell Cell { get; }Property Value
Remarks
When calculating a formula without setting it to a cell, such as by Aspose.Cells.Worksheet.CalculateFormula(System.String,Aspose.Cells.CalculationOptions), the formula will be calculated just like it has been set to cell A1, so both Aspose.Cells.CalculationData.CellRow and Aspose.Cells.CalculationData.CellColumn are 0. However, cell A1 in the worksheet may has not been instantiated. So for such kind of situation this property will be null.
CellColumn
Gets the column index of the cell where the function is in.
public int CellColumn { get; }Property Value
CellRow
Gets the row index of the cell where the function is in.
public int CellRow { get; }Property Value
FunctionName
Gets the function name to be calculated.
public string FunctionName { get; }Property Value
ParamCount
Gets the count of parameters
public int ParamCount { get; }Property Value
Workbook
Gets the Workbook object where the function is in.
public Workbook Workbook { get; }Property Value
Worksheet
Gets the Worksheet object where the function is in.
public Worksheet Worksheet { get; }Property Value
Methods
GetParamText(int)
Gets the literal text of the parameter at given index.
public string GetParamText(int index)Parameters
index int
index of the parameter(0 based)
Returns
literal text of the parameter
GetParamValue(int)
Gets the represented value object of the parameter at given index.
public object GetParamValue(int index)Parameters
index int
The index of the parameter(0 based)
Returns
The calculated value of the parameter.
Remarks
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 Aspose.Cells.Workbook.UpdateCustomFunctionDefinition(Aspose.Cells.CustomFunctionDefinition) or Aspose.Cells.FormulaParseOptions.CustomFunctionDefinition), then an array(object[][]) will be returned whose items are A1+B1,A2+B2,....
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.
public object[][] GetParamValueInArrayMode(int index, int maxRowCount, int maxColumnCount)Parameters
index int
The index of the parameter(0 based)
maxRowCount int
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 int
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
object[][]
An array which contains all items represented by the specified parameter.
Remarks
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 Aspose.Cells.Cells.MaxDataRow and Aspose.Cells.Cells.MaxDataColumn), otherwise the returned large array may increase memory cost with large amount of useless data.