Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

TdxSpreadSheetCustomConditionalFormattingRule.Index Property

Specifies the conditional formatting rule’s index in the parent conditional formatting controller.

#Declaration

Delphi
property Index: Integer read; write;

#Property Value

Type Description
Integer

The rule’s index that specifies the conditional formatting rule’s priority.

The lower the index, the higher the rule’s priority. If the index is 0, the rule has the highest priority.

#Remarks

The conditional formatting controller assigns consecutive numbers starting from 0 to the Index property of every rule according to its order of creation. The Index property value also determines the rule’s evaluation priority and position in the Conditional Formatting Rules Manager dialog:

VCL Spreadsheet: Rule Order in the Conditional Formatting Rules Manager Dialog

You can use the Index property to change the conditional formatting rule’s precedence. For instance, if the Index property is set to 0, the rule has the highest priority. Since all rule indexes within the same conditional formatting controllers are unique, all other rules automatically update their Index property values.

The conditional formatting controller evaluates rule precedences only if two or more rules affect the same areas. To prevent all rules with lower priority from affecting the same areas, set the StopIfTrue property to True.

#Limitations

Only the following TdxSpreadSheetCustomConditionalFormattingRule class descendants expose the StopIfRule property:

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