RangeFilterPredefinedDateTimePeriodsEventArgs.Periods Property

Provides access to a collection of predefined periods displayed in the Edit Periods dialog.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public IList<DateTimePeriod> Periods { get; }

VB.NET

Public ReadOnly Property Periods As IList(Of DateTimePeriod)

Property Value

Type	Description
IList<DateTimePeriod>	A collection of DateTimePeriod objects that specify predefined date-time periods.

Example

This example shows how to use the DashboardDesigner.RangeFilterPredefinedDateTimePeriods event to customize a default list of predefined periods from the Edit Periods dialog. Note that this list is customized when filtering by year is applied in the dialog.

C#

    using DevExpress.DashboardCommon;        
      //...           
    private void dashboardDesigner_RangeFilterPredefinedDateTimePeriods(object sender, RangeFilterPredefinedDateTimePeriodsEventArgs e) {
            if (e.ItemComponentName == "range" && e.FilterType == DateTimePeriodFilterType.Year) {
                // Creates a new 'Last 4 Years' period.
                FlowDateTimePeriodLimit startDate = new FlowDateTimePeriodLimit(DateTimeInterval.Year, -4);
                FlowDateTimePeriodLimit endDate = new FlowDateTimePeriodLimit(DateTimeInterval.Year, 0);
                DateTimePeriod period = new DateTimePeriod("Last 4 Years", startDate, endDate);
                e.Periods.Insert(3, period);

                // Removes the default 'Last Year' period.
                period = e.Periods.FirstOrDefault(p => p.Name == DashboardWinLocalizer.GetString(DashboardWinStringId.PeriodLastYear));
                e.Periods.Remove(period);
            }
        }

VB.NET

    Imports DevExpress.DashboardCommon
      '...           
    Private Sub dashboardDesigner_RangeFilterPredefinedDateTimePeriods(ByVal sender As Object, ByVal e As RangeFilterPredefinedDateTimePeriodsEventArgs)
            If e.ItemComponentName = "range" AndAlso e.FilterType = DateTimePeriodFilterType.Year Then
                ' Creates a new 'Last 4 Years' period.
                Dim startDate As New FlowDateTimePeriodLimit(DateTimeInterval.Year, -4)
                Dim endDate As New FlowDateTimePeriodLimit(DateTimeInterval.Year, 0)
                Dim period As New DateTimePeriod("Last 4 Years", startDate, endDate)
                e.Periods.Insert(3, period)

                ' Removes the default 'Last Year' period.
                period = e.Periods.FirstOrDefault(Function(p) p.Name = DashboardWinLocalizer.GetString(DashboardWinStringId.PeriodLastYear))
                e.Periods.Remove(period)
            End If
    End Sub