DateTimePeriod.Name Property

Gets or sets the name of the date-time period.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public string Name { get; set; }

VB.NET

Public Property Name As String

Property Value

Type	Description
String	A String that specifies the name of the date-time period.

Remarks

You can assign the Name value to the RangeFilterDashboardItem.DefaultDateTimePeriodName property to specify the default selected range for the Range Filter.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Name property.

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#L28

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

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

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

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

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

VB.NET

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}

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}

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.