TcxDataControllerConditionalFormatting Class
A conditional formatting controller that applies rules to individual fields in its data controller.
Declaration
TcxDataControllerConditionalFormatting = class(
TdxSpreadSheetCustomConditionalFormatting
)Remarks
This class implements the conditional formatting rule management functionality available in data presentation controls, including TcxGrid, TcxDBVerticalGrid, TcxVerticalGrid, TcxVirtualVerticalGrid, TcxTreeList, TcxDBTreeList, and TcxVirtualTreeList controls. The conditional formatting controller evaluates record values in an affected field and applies custom formatting to the corresponding cells for which a rule’s condition is met. You can call the ShowRulesManagerDialog procedure to invoke the “Conditional Formatting Rules Manager” dialog for any of the listed controls to allow end users to create, customize, and delete conditional formatting rules.
The TcxDataControllerConditionalFormatting class provides the following members that allow you to:
Apply a new conditional formatting rule to the specified dataset field (Add);
Obtain the total number of conditional formatting rules that affect fields in a data controller (RuleCount);
Access individual conditional formatting rules (Rules);
Re-evaluate all conditional formatting rules (FlushCache);
Identify if the “Conditional Formatting Rules Manager” dialog is available and invoke it (CanShowRulesManagerDialog and ShowRulesManagerDialog);
Exclude filtered out records from all conditional formatting calculations (ExcludeFilteredOutRecords);
Access the data controller to whose fields the conditional formatting rules are applied (DataController);
Identify if the data presentation control displays a specific field (IsFieldVisible);
Delete all conditional formatting rules simultaneously (Clear);
Obtain the specified dataset field’s display name (GetFieldDisplayName);
Create a string of delimited references from the specified Grid View area (ReferencesToString);
Delete an individual conditional formatting rule (Remove);
Clear the rule list and repopulate it with rules obtained from another conditional formatting controller (Assign).
You can access a conditional formatting controller via the following properties that data presentation controls provide:
An ExpressQuantumTreeList control’s ConditionalFormatting property;
An ExpressVerticalGrid control’s ConditionalFormatting property;
An individual ExpressQuantumGrid Table or Banded View’s ConditionalFormatting property.