MVCxVerticalGridFormatConditionCollection.AddTopBottom(String, GridTopBottomRule, GridConditionHighlightFormat) Method

Creates a new format condition item with the specified settings and adds it to the MVCxVerticalGridFormatConditionCollection collection.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v23.2.dll

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public VerticalGridFormatConditionTopBottom AddTopBottom(
    string fieldName,
    GridTopBottomRule rule,
    GridConditionHighlightFormat format
)

VB.NET

Public Function AddTopBottom(
    fieldName As String,
    rule As GridTopBottomRule,
    format As GridConditionHighlightFormat
) As VerticalGridFormatConditionTopBottom

Parameters

Name	Type	Description
fieldName	String	A String value that is the name of the processed data field. This value is assigned to the GridFormatConditionBase.FieldName property.
rule	GridTopBottomRule	One of the GridTopBottomRule enumeration values specifying the format condition rule. This value is assigned to the GridFormatConditionTopBottom.Rule property.
format	GridConditionHighlightFormat	One of the GridConditionHighlightFormat enumeration values specifying the format (color scale) applied to cells. This value is assigned to the GridFormatConditionExpressionBase.Format property.

Returns

Type	Description
VerticalGridFormatConditionTopBottom	An VerticalGridFormatConditionTopBottom object that is the newly created format condition item.