RangeFilterDashboardItem.DateTimePeriods Property

Provides access to a collection of date-time periods that can be used to select a predefined range in the Range Filter.

Namespace: DevExpress.DashboardCommon

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

NuGet Packages: DevExpress.Dashboard.Core, DevExpress.WindowsDesktop.Dashboard.Core

Declaration

C#

public DateTimePeriodCollection DateTimePeriods { get; }

VB.NET

Public ReadOnly Property DateTimePeriods As DateTimePeriodCollection

Property Value

Type	Description
DateTimePeriodCollection	A DateTimePeriodCollection object that is a collection of date-time periods.

Example

This code snippet demonstrates how to create predefined DateTime periods for the Range Filter dashboard item.

View Example: How to Bind the Range Filter Dashboard Item to Data at Runtime

C#

using DevExpress.DashboardCommon;
// ...
rangeFilter.DateTimePeriods.AddRange(
    DateTimePeriod.CreateLastYear(),
    DateTimePeriod.CreateNextDays("Next 7 Days", 7),
    new DateTimePeriod
    { Name = "Month To Date",
        Start = new FlowDateTimePeriodLimit(DateTimeInterval.Month,0),
        End = new FlowDateTimePeriodLimit(DateTimeInterval.Day,1)
    },
    new DateTimePeriod
    { Name = "Jul-18-2018 - Jan-18-2019",
        Start = new FixedDateTimePeriodLimit(new DateTime(2018, 7, 18)),
        End = new FixedDateTimePeriodLimit(new DateTime(2019, 1, 18)) }
    );
// Specify the period selected when the control is initialized.
rangeFilter.DefaultDateTimePeriodName = "Year To Date";

VB.NET

Imports DevExpress.DashboardCommon
' ...
rangeFilter.DateTimePeriods.AddRange(
    DateTimePeriod.CreateLastYear(),
    DateTimePeriod.CreateNextMonths("Next 3 Months", 3),
    New DateTimePeriod With {
    .Name = "Year To Date",
    .Start = New FlowDateTimePeriodLimit(DateTimeInterval.Year, 0),
    .End = New FlowDateTimePeriodLimit(DateTimeInterval.Day, 1)},
    New DateTimePeriod With {
    .Name = "Jul-18-2018 - Jan-18-2019",
    .Start = New FixedDateTimePeriodLimit(New Date(2018, 7, 18)),
    .End = New FixedDateTimePeriodLimit(New Date(2019, 1, 18))})
' Specify the period selected when the control Is initialized.
rangeFilter.DefaultDateTimePeriodName = "Year To Date"