TdxSpreadSheetCustomConditionalFormatting Class
The base class for conditional formatting controllers in DevExpress controls.
Declaration
TdxSpreadSheetCustomConditionalFormatting = class abstract(TObject)Remarks
A conditional formatting controller is a collection of conditional formatting rules applied to target cell ranges. The Conditional Formatting Rules Manager dialog allows users to view, customize, and manage all conditional formatting rules.
Main API Members
The list below outlines key members of the TdxSpreadSheetCustomConditionalFormatting class. These members allow you to manage conditional formatting rules in Spreadsheet, Report Designer, Data Grid, Vertical Grid, and Tree List controls.
Rule Collection Management
- Add
- Creates a new conditional formatting rule of the required type.
- Clear
- Deletes all stored conditional formatting rules in the collection.
- Remove
Allows you to delete individual conditional formatting rules.
Alternatively, you can release a rule in code (call the Free procedure in Delphi or use the
deletekeyword in C++Builder).- RuleCount
- Returns the total number of created conditional formatting rules.
- Rules
- Provides indexed access to stored conditional formatting rules.
General-Purpose API Members
- Assign
- Clears the rule collection and repopulates it from another conditional formatting controller.
- BeginUpdate | BeginEditing | EndUpdate | EndEditing
- Allow you to avoid excessive redraw operations during batch data and appearance setting changes.
- CellStyles
- Provides access to all custom styles applied to affected cells.
- FlushCache
- Recalculates the conditions of all rules in the collection.
- Owner
- Provides access to the parent worksheet, data grid View, vertical grid, or tree list control.
- ReferencesToString
Converts a cell area list to a delimited reference string.
You can call this function to generate cell range references for formula expressions.
Terminal TdxSpreadSheetCustomConditionalFormatting Class Descendants
Do not use the TdxSpreadSheetCustomConditionalFormatting class directly. Use the following descendants instead:
- TcxDataControllerConditionalFormatting
- A conditional formatting controller that applies rules to individual fields in its data controller.
- TdxSpreadSheetConditionalFormatting
- A conditional formatting controller of a Table View worksheet displayed by the Spreadsheet or Report Designer control.