FormatConditionDateOccurring Class

A format condition used to apply formatting to date-time values concerning a specific date and/or date interval relative to today.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v21.2.Core.dll

Declaration

C#

public class FormatConditionDateOccurring :
    FormatConditionStyleBase

VB.NET

Public Class FormatConditionDateOccurring
    Inherits FormatConditionStyleBase

Remarks

To create a format condition to apply formatting to the required date-time values, do the following.

• Specify a filter that identifies specific dates or date intervals using the FormatConditionDateOccurring.DateType property.
• Specify the required style settings applied to target elements using the FormatConditionStyleBase.StyleSettings property. You can change the color of dashboard item elements, font settings (AppearanceSettings) or add predefined icons (IconSettings).

Assign the resulting FormatConditionDateOccurring object to the DashboardItemFormatRule.Condition property.

Example

The Date Occurring format condition (FormatConditionDateOccurring) allows you to apply formatting to date-time values of a specific date and/or date interval relative to today.

This example demonstrates how to apply conditional formatting to Grid cells whose values fall into one of the predefined intervals.

View Example

Form1.cs

using DevExpress.DashboardCommon;
using DevExpress.XtraEditors;

namespace Grid_FormatRules {
    public partial class DateOccurringForm : XtraForm {
        public DateOccurringForm() {
            InitializeComponent();
            dashboardViewer1.AsyncDataLoading += OnDashboardViewerAsyncDataLoading;
            dashboardViewer1.DataSourceOptions.ObjectDataSourceLoadingBehavior = DevExpress.DataAccess.DocumentLoadingBehavior.LoadAsIs;

            Dashboard dashboard = new Dashboard();
            dashboard.LoadFromXml(@"..\..\Data\DashboardDate.xml");
            dashboardViewer1.Dashboard = dashboard;
            GridDashboardItem grid = (GridDashboardItem)dashboard.Items["gridDashboardItem1"];
            GridDimensionColumn date = (GridDimensionColumn)grid.Columns[0];

            GridItemFormatRule dateOccurringRule = new GridItemFormatRule(date);
            FormatConditionDateOccurring dateOccurringCondition = new FormatConditionDateOccurring();
            dateOccurringCondition.DateType = FilterDateType.MonthAgo1 | FilterDateType.MonthAgo2;
            dateOccurringCondition.StyleSettings = 
                new AppearanceSettings(FormatConditionAppearanceType.PaleOrange);
            dateOccurringRule.Condition = dateOccurringCondition;
            dateOccurringRule.ApplyToRow = true;

            grid.FormatRules.Add(dateOccurringRule);            
        }
        void OnDashboardViewerAsyncDataLoading(object sender, DataLoadingEventArgs e) {
            e.Data = DataGenerator.CreateData();
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports DevExpress.DashboardCommon
Imports DevExpress.XtraEditors

Namespace Grid_FormatRules
    Partial Public Class DateOccurringForm
        Inherits XtraForm
        Public Sub New()
            InitializeComponent()
            AddHandler dashboardViewer1.AsyncDataLoading, AddressOf OnDashboardViewerAsyncDataLoading
            dashboardViewer1.DataSourceOptions.ObjectDataSourceLoadingBehavior = DevExpress.DataAccess.DocumentLoadingBehavior.LoadAsIs

            Dim dashboard As New Dashboard()
            dashboard.LoadFromXml("..\..\Data\DashboardDate.xml")
            dashboardViewer1.Dashboard = dashboard
            Dim grid As GridDashboardItem = CType(dashboard.Items("gridDashboardItem1"), GridDashboardItem)
            Dim [date] As GridDimensionColumn = CType(grid.Columns(0), GridDimensionColumn)

            Dim dateOccurringRule As New GridItemFormatRule([date])
            Dim dateOccurringCondition As New FormatConditionDateOccurring()
            dateOccurringCondition.DateType = FilterDateType.MonthAgo1 Or FilterDateType.MonthAgo2
            dateOccurringCondition.StyleSettings = New AppearanceSettings(FormatConditionAppearanceType.PaleOrange)
            dateOccurringRule.Condition = dateOccurringCondition
            dateOccurringRule.ApplyToRow = True

            grid.FormatRules.Add(dateOccurringRule)
        End Sub
        Private Sub OnDashboardViewerAsyncDataLoading(ByVal sender As Object, ByVal e As DataLoadingEventArgs)
            e.Data = DataGenerator.CreateData()
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FormatConditionDateOccurring 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.

C#

how-to-apply-conditional-formatting-to-grid-cells-using-the-date-occurring-format-condition-t267749/CS/Grid_DateOccurring/Form1.cs#L18

GridItemFormatRule dateOccurringRule = new GridItemFormatRule(date);
FormatConditionDateOccurring dateOccurringCondition = new FormatConditionDateOccurring();
dateOccurringCondition.DateType = FilterDateType.MonthAgo1 | FilterDateType.MonthAgo2;

how-to-apply-conditional-formatting-to-grid-cells-in-win-dashboard/CS/Dashboard_ConditionalFormatting_Grid/DateOccurringForm.cs#L18

GridItemFormatRule dateOccurringRule = new GridItemFormatRule(date);
FormatConditionDateOccurring dateOccurringCondition = new FormatConditionDateOccurring();
dateOccurringCondition.DateType = FilterDateType.MonthAgo1 | FilterDateType.MonthAgo2;

VB.NET

how-to-apply-conditional-formatting-to-grid-cells-using-the-date-occurring-format-condition-t267749/VB/Grid_DateOccurring/Form1.vb#L20

Dim dateOccurringRule As New GridItemFormatRule([date])
Dim dateOccurringCondition As New FormatConditionDateOccurring()
dateOccurringCondition.DateType = FilterDateType.MonthAgo1 Or FilterDateType.MonthAgo2

how-to-apply-conditional-formatting-to-grid-cells-in-win-dashboard/VB/Dashboard_ConditionalFormatting_Grid/DateOccurringForm.vb#L21

Dim dateOccurringRule As New GridItemFormatRule([date])
Dim dateOccurringCondition As New FormatConditionDateOccurring()
dateOccurringCondition.DateType = FilterDateType.MonthAgo1 Or FilterDateType.MonthAgo2

Inheritance

Object

FormatConditionBase

FormatConditionStyleBase

FormatConditionDateOccurring

FormatConditionDateOccuring