RangeFilterState.PeriodName Property

Gets or sets the name of the selected predefined period.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public string PeriodName { get; set; }

VB.NET

Public Property PeriodName As String

Property Value

Type	Description
String	A String value that specifies the name of the selected predefined period.

Remarks

The following code snippet adds a predefined period of the Range Filter state to the entire dashboard state:

C#

public DashboardState CreateDashboardState() {
  DashboardState state = new DashboardState();
  // Set a predefined period for a Range Filter.
    state.Items.Add(new DashboardItemState("rangeFilterDashboardItem1") {
    RangeFilterState = new RangeFilterState(periodName: "6 month")
    });
  return state;
} 

VB.NET

Public Function CreateDashboardState() As DashboardState
  Dim state As New DashboardState()
  ' Set a predefined period for a Range Filter.
    state.Items.Add(New DashboardItemState("rangeFilterDashboardItem1") With {.RangeFilterState = New RangeFilterState(periodName:= "6 month")})
  Return state
End Function