Skip to main content

TdxSpreadSheetCustomConditionalFormatting Class

The base class for all classes that implement conditional formatting rule controllers in DevExpress products.

Declaration

TdxSpreadSheetCustomConditionalFormatting = class abstract(TObject)

Remarks

This class implements the core conditional formatting rule management functionality available in the Spreadsheet, Report Designer, Grid, Vertical Grid, and Tree List controls. End users can create, customize, and delete rules via the dedicated “Conditional Formatting Rules Manager” dialog that all listed controls provide.

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

  • Create a specific conditional formatting rule for the specified area (Add);

  • Identify the number of formatting rules applied to a worksheet or Grid View (RuleCount);

  • Access individual conditional formatting rules via their zero-based indexes (Rules);

  • Improve performance by preventing a worksheet or Grid View from repeated content refreshing when performing multiple operations on conditional formatting rules (BeginUpdate and EndUpdate);

  • Access the source of cell data and layouts to which the conditional formatting rules are applied (Owner);

  • Perform multiple conditional formatting changes as a single action (BeginEditing and EndEditing);

  • Invalidate the calculated rule conditions (FlushCache);

  • Convert a cell area list to a delimited string of references (ReferencesToString);

  • Access the hash table of custom styles applied to worksheet or Grid View cells (CellStyles);

  • Delete all conditional formatting rules simulatenously (Clear);

  • Clear the rule list and repopualte it with rules obtained from another conditional formatting controller (Assign);

  • Delete a specific rule (Remove).

You do not need to create instances of the TdxSpreadSheetCustomConditionalFormatting class. Use its descendants (TdxSpreadSheetConditionalFormatting and TcxDataControllerConditionalFormatting) instead.

A Table View worksheet provides access to its conditional formatting controller via the ConditionalFormatting property. To access all the controller’s type-specific members, cast the property value to the TdxSpreadSheetConditionalFormatting class.

Inheritance

TObject
TdxSpreadSheetCustomConditionalFormatting
See Also