TopBottomRuleFormatCondition Class

Represents the Top-Bottom and Average conditional formats.

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

Declaration

C#
VB.NET

public class TopBottomRuleFormatCondition :
    ExpressionConditionBase

Public Class TopBottomRuleFormatCondition
    Inherits ExpressionConditionBase

Remarks

This conditional format allows you to highlight top/bottom values or values that are above/below an average value.

The image below shows a grid column whose top 20 Profit values are green.

CFTopBottomExample

To create this conditional format in code, create the TopBottomRuleFormatCondition class instance and specify the following settings:

Specify the rule type using the TopBottomRuleFormatCondition.Rule property.
Specify the required rank value using the TopBottomRuleFormatCondition.Threshold property.
Use the FormatConditionBase.FieldName property to specify the column’s field name to which to apply the conditional format.
Specify the target cells’ formatting in one of the following ways:
- Specify the predefined format using the FormatConditionBase.PredefinedFormatName property.
- Set the custom format using the ExpressionConditionBase.Format property.
Add the resulting TopBottomRuleFormatCondition instance to the TableView.FormatConditions (or TreeListView.FormatConditions) collection.

The following code sample illustrates how to define a conditional format in markup:

XAML

<dxg:TableView.FormatConditions>
   <dxg:TopBottomRuleFormatCondition Rule="TopItems" Threshold="20" FieldName="Profit" PredefinedFormatName="GreenFillWithDarkGreenText" />
</dxg:TableView.FormatConditions>

The code sample below illustrates how to define the same conditional format in code-behind:

C#
VB.NET

var profitFormatCondition = new TopBottomRuleFormatCondition() {
   Rule = TopBottomRule.TopItems,
   Threshold = 20,    
   FieldName = "Profit", 
   PredefinedFormatName = "GreenFillWithDarkGreenText"
};
view.FormatConditions.Add(profitFormatCondition);

Dim profitFormatCondition = New TopBottomRuleFormatCondition() With {
   .Rule = TopBottomRule.TopItems,
   .Threshold = 20,
   .FieldName = "Profit",
   .PredefinedFormatName = "GreenFillWithDarkGreenText"
}
view.FormatConditions.Add(profitFormatCondition)

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

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.

how-to-apply-conditional-formatting-t135593/CS/ConditionalFormatting/MainWindow.xaml#L31

<dxg:DataBarFormatCondition FieldName="Sales" PredefinedFormatName="RedGradientDataBar"/>
<dxg:TopBottomRuleFormatCondition Expression="[Sales]" FieldName="{x:Null}" PredefinedFormatName="BoldText" Rule="TopPercent" Threshold="10"/>
<dxg:DataBarFormatCondition FieldName="Profit" PredefinedFormatName="GreenGradientDataBar"/>