FlowDateTimePeriodLimit Class

A floating date-time value used to specify boundaries for the DateTimePeriod.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public class FlowDateTimePeriodLimit :
    DateTimePeriodLimitBase,
    IDateTimePeriodLimit

VB.NET

Public Class FlowDateTimePeriodLimit
    Inherits DateTimePeriodLimitBase
    Implements IDateTimePeriodLimit

Remarks

The FlowDateTimePeriodLimit class allows you to specify a date-time value to define DateTimePeriod boundaries. The FlowDateTimePeriodLimit.Interval property specifies the interval between the current date and the required date. The FlowDateTimePeriodLimit.Offset property allows you to set the number of such intervals.

Note

Note that the FlowDateTimePeriodLimit.Offset property can accept negative and positive values. Negative values correspond to dates before the current date while positive values correspond to future dates.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FlowDateTimePeriodLimit 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-bind-a-range-filter-dashboard-item-to-data-in-code-e4773/CS/Dashboard_CreateRangeFilter/Form1.cs#L29

{ Name = "Year To Date",
  Start = new FlowDateTimePeriodLimit(DateTimeInterval.Year, 0),
  End = new FlowDateTimePeriodLimit(DateTimeInterval.Day, 1)

wpf-dashboard-create-datefilterdashboarditem/CS/WpfDateFilterDashboardItemSample/MainWindow.xaml.cs#L72

Name = "Month-to-date",
Start = new FlowDateTimePeriodLimit
{

winforms-dashboard-create-datefilterdashboarditem/CS/DateFilterDashboardItemSample/Form1.cs#L69

Name = DashboardWinLocalizer.GetString(DashboardWinStringId.PeriodMonthToDate),
Start = new FlowDateTimePeriodLimit
{

VB.NET

wpf-dashboard-create-datefilterdashboarditem/VB/WpfDateFilterDashboardItemSample/MainWindow.xaml.vb#L65

dateFilter.DateTimePeriods.AddRange(DateTimePeriod.CreateLastYear(), DateTimePeriod.CreateNextDays("Next 7 Days", 7), New DateTimePeriod With {
    .Name = "Month-to-date", .Start = New FlowDateTimePeriodLimit With {.Interval = DateTimeInterval.Month, .Offset = 0},
    .End = New FlowDateTimePeriodLimit With {.Interval = DateTimeInterval.Day, .Offset = 1}

winforms-dashboard-create-datefilterdashboarditem/VB/DateFilterDashboardItemSample/Form1.vb#L62

dateFilter.DateTimePeriods.AddRange(DateTimePeriod.CreateLastYear(), DateTimePeriod.CreateNextDays("Next 7 Days", 7), New DateTimePeriod With {
    .Name = DashboardWinLocalizer.GetString(DashboardWinStringId.PeriodMonthToDate), .Start = New FlowDateTimePeriodLimit With {.Interval = DateTimeInterval.Month, .Offset = 0},
    .End = New FlowDateTimePeriodLimit With {.Interval = DateTimeInterval.Day, .Offset = 1}

how-to-bind-a-range-filter-dashboard-item-to-data-in-code-e4773/VB/Dashboard_CreateRangeFilter/Form1.vb#L31

' You can show the item caption and use the Select Date Time Periods drop-down button to apply predefined ranges.
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.

Inheritance

Object

DateTimePeriodLimitBase

FlowDateTimePeriodLimit