TcxDataControllerConditionalFormatting Class
A conditional formatting controller in Data Grid, Vertical Grid, and Tree List controls.
Declaration
TcxDataControllerConditionalFormatting = class(
TdxSpreadSheetCustomConditionalFormatting
)Remarks
A conditional formatting controller is a collection of conditional formatting rules applied to target data items. 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 TcxDataControllerConditionalFormatting class. These members allow you to manage conditional formatting rules in 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.
Data-Related API Members
- DataController
- Provides access to the parent data controller.
- ExcludeFilteredOutRecords
- Allows you to exclude filtered out records from conditional formatting rule calculation.
- GetFieldDisplayName
- Returns the target field’s display name.
- IsFieldVisible
- Identifies if an individual field (data item) is visible.
- ReferencesToString
Converts target rule areas to a delimited reference string.
You can call this function to generate cell range references for formula expressions.
General-Purpose API Members
- Assign
- Clears the rule collection and repopulates it from another conditional formatting controller.
- BeginUpdate | EndUpdate
- Allow you to avoid excessive redraw operations during batch data and appearance setting changes.
- CanShowRulesManagerDialog
- Identifies if the Conditional Formatting Rules Manager dialog is available.
- CellStyles
- Provides access to all custom styles applied to affected cells.
- FlushCache
- Recalculates criteria of all rules in the collection.
- Owner
- Provides access to the parent worksheet, data grid View, vertical grid, or tree list control.
- ShowRulesManagerDialog
- Displays the Conditional Formatting Rules Manager dialog.
Direct TcxDataControllerConditionalFormatting Class References
The following public API members reference a TcxDataControllerConditionalFormatting object:
- TcxCustomGridTableView.ConditionalFormatting
- Provides access to the conditional formatting controller.
- TcxCustomTreeList.ConditionalFormatting
- Provides access to the conditional formatting controller.
- TcxCustomVerticalGrid.ConditionalFormatting
- Provides access to the conditional formatting controller.