Skip to main content

TdxSpreadSheetCustomFormula Class

The base class for all classes that implement containers for storing parsed formula expressions.

Declaration

TdxSpreadSheetCustomFormula = class(
    TObject
)

Remarks

This class implements the base functionality required by Microsoft Excel-style formula expressions supported by all DevExpress data export and conditional formatting engines, in addition to the Spreadsheet and Report Designer controls.

The TdxSpreadSheetCustomFormula class provides the following members that allow you to:

  • Obtain the formula evaluation or calculation error code (ErrorCode and ErrorIndex);

  • Obtain the parsed formula as a text string (AsText and SourceText);

  • Identify a cell to which the formula expression is anchored (Anchor, AnchorColumn, and AnchorRow);

  • Access the View (a worksheet or Grid View) that contains the formula expression’s anchor cell (View);

  • Access the controller that handles the formula expression (Controller);

  • Access the parsed formula expression’s tokens (Tokens);

  • Obtain the formula calculation result (Value and ActualValue);

  • Switch the formula expression calculation between the array and single value result modes (IsArrayFormula);

  • Obtain the rectangular cell range occupied by the calculated array result (ArrayFormulaArea and ArrayFormulaSize).

You do not need to create instances of the TdxSpreadSheetCustomFormula class. Use its descendants (TdxSpreadSheetFormula and TdxSpreadSheetConditionalFormattingExpression) instead.

Inheritance

TObject
TdxSpreadSheetCustomFormula
See Also