Skip to main content

TdxSpreadSheetConditionalFormattingRuleDuplicateValues Class

A Duplicate Values conditional formatting rule.

Declaration

TdxSpreadSheetConditionalFormattingRuleDuplicateValues = class(
    TdxSpreadSheetConditionalFormattingRuleStyleBased
)

Remarks

A Duplicate Values conditional formatting rule applies custom appearance settings to all cells that contain duplicate values within target areas. The Duplicate Values rule complements Unique Values.

VCL Spreadsheet: A "Duplicate Values" Rule Example

Main API Members

The list below outlines key members of the TdxSpreadSheetConditionalFormattingRuleDuplicateValues class. These members allow you to configure Duplicate Values 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.

Duplicate Values Rule-Specific API Members

Style
Allows you to define the appearance of formatted cells.

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 Duplicate Values Rule

To create a Duplicate Values conditional formatting rule, you can call one of the overloaded Add procedures of the corresponding conditional formatting controller and pass a reference to the TdxSpreadSheetConditionalFormattingRuleDuplicateValues 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 TdxSpreadSheetConditionalFormattingRuleDuplicateValues class and pass the target conditional formatting controller as the AOwner parameter.

Delete a Conditional Formatting Rule

To delete an individual Duplicate Values conditional formatting rule, you can use one of the following options:

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

Other Style-Based Conditional Formatting Rule Classes

You can also use the following style-based rules to apply spreadsheet-compatible style settings to cells that meet specific conditions:

TdxSpreadSheetConditionalFormattingRuleAboveOrBelowAverage
An Above or Below Average conditional formatting rule.
TdxSpreadSheetConditionalFormattingRuleCellIs
A Cell Is conditional formatting rule.
TdxSpreadSheetConditionalFormattingRuleExpression
An Expression conditional formatting rule.
TdxSpreadSheetConditionalFormattingRuleTopBottomValues
A Top/Bottom Values conditional formatting rule.
TdxSpreadSheetConditionalFormattingRuleUniqueValues
A Unique Values conditional formatting rule.

Indirect TdxSpreadSheetConditionalFormattingRuleDuplicateValues Class References

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

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

See Also