TopBottomRuleFormatCondition.Rule Property

Specifies the rule for a conditional format. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v23.2.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public TopBottomRule Rule { get; set; }

VB.NET

Public Property Rule As TopBottomRule

Property Value

Type	Description
TopBottomRule	A TopBottomRule enumeration value.

Available values:

Name	Description
TopItems	The style is applied to cells whose values are the largest for the field. The number of cells is specified by the TopBottomRuleFormatCondition.Threshold (TopBottomRuleFormatCondition.Threshold) property.
TopPercent	The style is applied to cells whose values are the largest for the field. The percentage of cells is specified by the TopBottomRuleFormatCondition.Threshold (TopBottomRuleFormatCondition.Threshold) property.
BottomItems	The style is applied to cells whose values are the lowest for the field. The number of cells is specified by the TopBottomRuleFormatCondition.Threshold (TopBottomRuleFormatCondition.Threshold) property.
BottomPercent	The style is applied to cells whose values are the lowest for the field. The percentage of cells is specified by the TopBottomRuleFormatCondition.Threshold (TopBottomRuleFormatCondition.Threshold) property.
AboveAverage	The style is applied to cells whose values are above the average value for the field.
BelowAverage	The style is applied to cells whose values are below the average value for the field.

Remarks

The Rule property is used to set a rule that specifies which cells (or corresponding rows) are formatted.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Rule property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

wpf-data-grid-apply-conditional-formatting/CS/ConditionalFormatting/MainWindow.xaml#L23

<dxg:DataBarFormatCondition FieldName="Sales" PredefinedFormatName="RedGradientDataBar"/>
<dxg:TopBottomRuleFormatCondition Expression="[Sales]" Rule="TopPercent" Threshold="10" PredefinedFormatName="BoldText"/>
<dxg:FormatCondition Expression="[SalesVsTarget] &lt; 0.0m" FieldName="SalesVsTarget" PredefinedFormatName="RedText"/>