asposecells.api
Class AbstractCalculationMonitor

Monitor for user to track the progress of formula calculation.

Property Getters/Setters Summary
methodgetCalculatedValue()
           Gets the newly calculated value of the cell. Should be used only in afterCalculate(int, int, int).
methodgetOriginalValue()
           Gets the old value of the calculated cell. Should be used only in beforeCalculate(int, int, int) and afterCalculate(int, int, int).
methodgetValueChanged()
           Whether the cell's value has been changed after the calculation. Should be used only in afterCalculate(int, int, int).
 
Method Summary
methodafterCalculate(sheetIndex, rowIndex, colIndex)
           Implement this method to do business after one cell has been calculated.
methodbeforeCalculate(sheetIndex, rowIndex, colIndex)
           Implement this method to do business before calculating one cell.
methodonCircular(circularCellsData)
           Implement this method to do business when calculating one cell and circular references being encountered
 

Property Getters/Setters Detail

getOriginalValue : Object 

Object getOriginalValue()
Gets the old value of the calculated cell. Should be used only in beforeCalculate(int, int, int) and afterCalculate(int, int, int).

getValueChanged : boolean 

boolean getValueChanged()
Whether the cell's value has been changed after the calculation. Should be used only in afterCalculate(int, int, int).

getCalculatedValue : Object 

Object getCalculatedValue()
Gets the newly calculated value of the cell. Should be used only in afterCalculate(int, int, int).

Method Detail

beforeCalculate

 beforeCalculate(sheetIndex, rowIndex, colIndex)
Implement this method to do business before calculating one cell.
Parameters:
sheetIndex: int - Index of the sheet that the cell belongs to.
rowIndex: int - Row index of the cell
colIndex: int - Column index of the cell

afterCalculate

 afterCalculate(sheetIndex, rowIndex, colIndex)
Implement this method to do business after one cell has been calculated.
Parameters:
sheetIndex: int - Index of the sheet that the cell belongs to.
rowIndex: int - Row index of the cell
colIndex: int - Column index of the cell

onCircular

boolean onCircular(circularCellsData)
Implement this method to do business when calculating one cell and circular references being encountered To process circular references, please make sure the value of property WorkbookSettings.Iteration is true and WorkbookSettings.MaxIteration is greater than 0.
Parameters:
circularCellsData: Iterator - IEnumerator to enumerate cells(represented by CalculationCell object) in the circular chain
Returns:
Whether the formula engine needs to calculate those cells in circular after this call. True to let the formula engine continue to do calculation for them. False to let the formula engine just mark those cells in circular as Calculated. At the meantime, user may set the expected value as calculated result for the cell in this implementation.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.