DateTimePeriod Class
A date-time period that is used to select a predefined range in the Range Filter and Date Filter items.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v23.1.Core.dll
NuGet Packages: DevExpress.Dashboard.Core, DevExpress.Win.Dashboard.Design
Declaration
public class DateTimePeriod :
IXmlSerializableElement,
IDateTimePeriodLimitOwner,
INameContainer,
INamedItem,
ISupportPrefix,
IDateTimePeriodRemarks
The DateTimePeriod objects are predefined date-time periods in Range Filter and Date Filter items. The RangeFilterDashboardItem.DateTimePeriods and DateFilterDashboardItem.DateTimePeriods properties provide access to the collections of DateTimePeriod objects.
Use the DateTimePeriod static methods to create a predefined period. To create a custom period, instantiate the DateTimePeriod class and perform the following steps:
- Specify the boundaries. Create the FixedDateTimePeriodLimit or FlowDateTimePeriodLimit class objects and assign them to the DateTimePeriod.Start and DateTimePeriod.End properties.
Note
If you do not specify DateTimePeriod.Start/DateTimePeriod.End, the selection will begin from the start/end of the visible range.
- Specify the period name. Assign a string to the DateTimePeriod.Name property.
Example
This code snippet demonstrates how to create predefined DateTime periods for the Range Filter dashboard item.
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";