RangeFilterDashboardItem.DateTimePeriods Property

Gets a collection of date-time periods that can be used to select a predefined range in the Range Filter using its context menu.

Namespace: DevExpress.DashboardCommon

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

Declaration

public DateTimePeriodCollection DateTimePeriods { get; }
Public ReadOnly Property DateTimePeriods As DateTimePeriodCollection

Property Value

Type Description
DateTimePeriodCollection

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

Remarks

The RangeFilterDashboardItem class exposes the DateTimePeriods property, providing access to a collection of predefined date-time periods.

To add the required date-time period in code, create the DateTimePeriod class instance and execute the following steps.

If necessary, you can specify the default selected range for the Range Filter. To do this, assign the DateTimePeriod.Name value to the RangeFilterDashboardItem.DefaultDateTimePeriodName property.

Examples

This example shows how to create a predefined date-time period for the Range Filter dashboard item.

            RangeFilterDashboardItem rangeFilter = new RangeFilterDashboardItem();
            // ...

            FixedDateTimePeriodLimit startDate = new FixedDateTimePeriodLimit(new System.DateTime(2015, 1, 1));
            FlowDateTimePeriodLimit endDate = new FlowDateTimePeriodLimit(DateTimeInterval.Month, -1);
            DateTimePeriod customPeriod = new DateTimePeriod("Custom period", startDate, endDate);
            rangeFilter.DateTimePeriods.Add(customPeriod); 
See Also