FormatConditionBase Class

Serves as a base for classes that represent format conditions.

Namespace: DevExpress.Mobile.DataGrid

Assembly: DevExpress.Mobile.Grid.v18.1.dll

Declaration

public abstract class FormatConditionBase :
    BindableObject
Public MustInherit Class FormatConditionBase
    Inherits BindableObject

The FormatConditionBase class implements the base functionality for classes that represent format conditions.

A format condition defines appearance settings and criteria. When a cell value matches the criteria, the appearance settings are applied to this cell or row containing these cells.

Examples

This example illustrates how to apply a format to rows in a GridControl that match a specific expression.

ConditionalFormatting_Expression

An expression is a string that, when parsed and processed, evaluates some value. Expressions consist of column names, constants, operators, and functions. In this example, a Boolean expression is used. If the expression evaluates to true, the format is applied. The format highlights rows that have values in the Total column that are less than 100.

  1. Create a new FormatCondition class instance.
  2. Set this object's FormatConditionBase.FieldName property to Total. This column provides values to test against the formatting rule.
  3. Assign the expression string to the ExpressionConditionBase.Expression property.
  4. Assign one of the predefined formats to the FormatConditionBase.PredefinedFormatName property. All available format names are listed in the Predefined Format Names document.
  5. Set the ExpressionConditionBase.ApplyToRow property to true to apply the format to entire rows instead of individual column cells.
  6. To apply a conditional formatting rule represented by the created FormatCondition object, add this object to the GridControl.FormatConditions collection.
using DevExpress.Mobile.DataGrid;
// ...

FormatCondition condition = new FormatCondition();
condition.FieldName = "Total";
condition.Expression = "[Total] < 100";
condition.PredefinedFormatName = "LightRedFillWithDarkRedText";
condition.ApplyToRow = true;

grid.FormatConditions.Add (condition);

See Also