DashboardItemFormatRule Class

Represents a format rule used to apply conditional formatting to dashboard items.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#
VB.NET

public abstract class DashboardItemFormatRule :
    IFormatConditionOwner,
    IDataItemRepositoryProvider,
    IXmlSerializableElement,
    ISupportPrefix,
    INameContainer,
    INamedItem

Public MustInherit Class DashboardItemFormatRule
    Implements IFormatConditionOwner,
               IDataItemRepositoryProvider,
               IXmlSerializableElement,
               ISupportPrefix,
               INameContainer,
               INamedItem

Remarks

Dashboard items that support conditional formatting expose the FormatRules property, providing access to a collection of the DashboardItemFormatRule descendants.

To create a new rule, do the following.

Create the required condition (the FormatConditionBase descendant), specify its settings and assign the resulting object to the DashboardItemFormatRule.Condition property.
Use the DashboardItemFormatRule.Enabled property to specify whether the current format rule is enabled.
Make sure that the current DashboardItemFormatRule object is properly specified using the DashboardItemFormatRule.IsValid property.

Finally, add the created format rule to the FormatRules collection exposed by the dashboard item.