DashboardItemState.RangeFilterState Property

Gets or sets the state of the Range Filter and Date Filter dashboard items.

Namespace : DevExpress.DashboardCommon

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

NuGet Package : DevExpress.Dashboard.Core

Declaration

C#
VB.NET

csharp

public RangeFilterState RangeFilterState { get; set; }

Public Property RangeFilterState As RangeFilterState

Property Value

Type	Description
RangeFilterState

A RangeFilterState object that specifies the state of the Range Filter and Date Filter dashboard items.

Remarks

A Range Filter can use both a range of values and predefined periods.

The following code snippet adds Range Filter state values to the entire dashboard state (DashboardState):

C#
VB.NET

csharp

public DashboardState CreateDashboardState() {
  DashboardState state = new DashboardState();
  // Set a range for a Range Filter.
    state.Items.Add(new DashboardItemState("rangeFilterDashboardItem1") {
    RangeFilterState = new RangeFilterState(new RangeFilterSelection(new DateTime(2015, 1, 1), new DateTime(2017, 1, 1)))
    });
  return state;
}

Public Function CreateDashboardState() As DashboardState
  Dim state As New DashboardState()
  ' Set a range for a Range Filter.
    state.Items.Add(New DashboardItemState("rangeFilterDashboardItem1") With {.RangeFilterState = New RangeFilterState(New RangeFilterSelection(New DateTime(2015, 1, 1), New DateTime(2017, 1, 1)))})
  Return state
End Function

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

C#
VB.NET

csharp

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;
}

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

The following code snippet clears states (unselects all values) of the Range Filter and Date Filter dashboard items:

C#
VB.NET

csharp

protected void ASPxDashboard1_SetInitialDashboardState(object sender, SetInitialDashboardStateEventArgs e) {
  var state = new DashboardState();
    // ...
  state.Items.Add(new DashboardItemState("rangeFilterDashboardItem1"){
      RangeFilterState = new RangeFilterState()
  });
  state.Items.Add(new DashboardItemState("dateFilterDashboardItem1"){
      RangeFilterState = new RangeFilterState()
  });
  // ...
  e.InitialState = state
}

Protected Sub ASPxDashboard1_SetInitialDashboardState(ByVal sender As Object, ByVal e As SetInitialDashboardStateEventArgs)
    Dim state = New DashboardState()
    ' ...
    state.Items.Add(New DashboardItemState("rangeFilterDashboardItem1") With {.RangeFilterState = New RangeFilterState()})
  state.Items.Add(New DashboardItemState("dateFilterDashboardItem1") With {.RangeFilterState = New RangeFilterState()})
  ' ...
    e.InitialState = state
End Sub

See the following topics for details on how to assign a dashboard state to a Dashboard control: