TdxSpreadSheetConditionalFormattingRuleDataBar Class

A Data Bar conditional formatting rule.

Declaration

TdxSpreadSheetConditionalFormattingRuleDataBar = class(
    TdxSpreadSheetConditionalFormattingRuleCustomScale
)

Remarks

A Data Bar rule visualizes all numeric values as horizontal bars within affected cells.

VCL Spreadsheet: A "Data Bar" Rule Example

Main API Members

The list below outlines key members of the TdxSpreadSheetConditionalFormattingRuleDataBar class. These members allow you to configure Data Bar rule settings.

Common Rule API Members

Areas: Allows you to manage the conditional formatting rule’s target areas.
Clone: Copies the rule between different sets of target areas.
Index | StopIfTrue: Specify how the rule interacts with other conditional formatting rules applied to the same cells.

Rule-Specific API Members

MinValue | MaxValue: Specify minimum and maximum threshold values.
ShowValue: Specifies if cell values are visible.
Style: Allows you to customize bar appearance.

General-Purpose API Members

Assign: Copies compatible settings between conditional formatting rules.
BeginUpdate | EndUpdate: Allow you to avoid excessive redraw operations during batch rule setting changes.
GetDetails: Returns the conditional formatting rule’s name displayed in the Conditional Formatting Rules Manager dialog.
LoadFromStream | SaveToStream: Allow you to store conditional formatting rule settings in a stream.
Owner: Provides access to the parent conditional formatting controller.

Create a Data Bar Rule

To create a Data Bar conditional formatting rule, you can call one of the overloaded Add procedures of the corresponding conditional formatting controller and pass a reference to the TdxSpreadSheetConditionalFormattingRuleDataBar class as the ARuleClass parameter:

TcxDataControllerConditionalFormatting.Add: Creates a new conditional formatting rule for a Data Grid, Tree List, or Vertical Grid control.
TdxSpreadSheetConditionalFormatting.Add: Creates a new conditional formatting rule in a spreadsheet document.

Alternatively, you can call the constructor of the TdxSpreadSheetConditionalFormattingRuleDataBar class and pass the target conditional formatting controller as the AOwner parameter.

Delete a Conditional Formatting Rule

To delete an individual Data Bar conditional formatting rule, you can do one of the following:

Call the TdxSpreadSheetCustomConditionalFormatting.Remove procedure and pass the rule as a parameter.
Release the rule directly in code (call the Free procedure in Delphi or use the delete keyword in C++Builder).

Alternatively, you can call the TdxSpreadSheetCustomConditionalFormatting.Clear procedure to delete all rules in a conditional formatting controller.

Other Threshold-Based Conditional Formatting Rule Classes

You can also use the following threshold-based rules:

TdxSpreadSheetConditionalFormattingRuleIconSet: An Icon Set conditional formatting rule.
TdxSpreadSheetConditionalFormattingRuleThreeColorScale: A Three Color Scale conditional formatting rule.
TdxSpreadSheetConditionalFormattingRuleTwoColorScale: A Two Color Scale conditional formatting rule.

Indirect TdxSpreadSheetConditionalFormattingRuleDataBar Class References

The TdxSpreadSheetCustomConditionalFormatting.Rules property references the TdxSpreadSheetConditionalFormattingRuleDataBar class as a TdxSpreadSheetCustomConditionalFormattingRule object.

To access all public API members, you need to cast the returned object to the TdxSpreadSheetConditionalFormattingRuleDataBar class. You can call the rule’s ClassType function to identify the actual rule type.