CardFormatRuleLayoutElement.CreateDimensionElement(String) Method

Creates a dimension layout element to which a format rule applies.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public static CardFormatRuleLayoutElement CreateDimensionElement(
    string dimensionId
)

VB.NET

Public Shared Function CreateDimensionElement(
    dimensionId As String
) As CardFormatRuleLayoutElement

Parameters

Name	Type	Description
dimensionId	String	The dimension layout element’s identifier.

Returns

Type	Description
CardFormatRuleLayoutElement	The card’s dimension layout element.

Remarks

The following example shows how apply the Value format rule to cards whose actual value is greater than the set condition value. The rule applies the green check icon to the card’s dimension layout element. The CreateDimensionElement method uses the element’s unique ID to obtain the dimension layout element.

C#

using System.Windows.Forms;
using DevExpress.DashboardCommon;

CardDashboardItem cardItem = (CardDashboardItem)dashboardDesigner1.Dashboard.Items["cardDashboardItem1"];

CardItemDeltaFormatRule iconRule = new CardItemDeltaFormatRule();
iconRule.DeltaValueType = DeltaValueType.ActualValue;
iconRule.Card = cardItem.Cards[0];
FormatConditionValue valueCondition2 = new FormatConditionValue(DashboardFormatCondition.Greater, 1000000);
valueCondition2.StyleSettings = new IconSettings(FormatConditionIconType.IndicatorGreenCheck);
iconRule.Condition = valueCondition2;
var dimensionId = cardItem.SeriesDimensions[0].UniqueId;
CardFormatRuleLayoutElement dimensionLayoutElement = CardFormatRuleLayoutElement.CreateDimensionElement(dimensionId);
iconRule.ApplyToLayoutElement = dimensionLayoutElement;
cardItem.FormatRules.Add(iconRule);

VB.NET

Imports System.Windows.Forms
Imports DevExpress.DashboardCommon

Dim card As CardDashboardItem = CType(dashboardDesigner1.Dashboard.Items("cardDashboardItem1"), CardDashboardItem)

Dim iconRule As New CardItemDeltaFormatRule()
iconRule.DeltaValueType = DeltaValueType.ActualValue
iconRule.Card = cardItem.Cards(0)
Dim valueCondition2 As New FormatConditionValue(DashboardFormatCondition.Greater, 1000000)
valueCondition2.StyleSettings = New IconSettings(FormatConditionIconType.IndicatorGreenCheck)
iconRule.Condition = valueCondition2
Dim dimensionId = cardItem.SeriesDimensions(0).UniqueId
Dim dimensionLayoutElement As CardFormatRuleLayoutElement = CardFormatRuleLayoutElement.CreateDimensionElement(dimensionId)
iconRule.ApplyToLayoutElement = dimensionLayoutElement
cardItem.FormatRules.Add(iconRule)

Tip

Documentation:

• Cards - Conditional Formatting
• Cards - Layout