dashboard-devexpress-dot-dashboardwin-dot-dashboardviewer-0a7efae5.md
Allows you to specify the default selected range in the Range Filter dashboard item.
Namespace : DevExpress.DashboardWin
Assembly : DevExpress.Dashboard.v25.2.Win.dll
NuGet Package : DevExpress.Win.Dashboard
public event RangeFilterDefaultValueEventHandler RangeFilterDefaultValue
Public Event RangeFilterDefaultValue As RangeFilterDefaultValueEventHandler
The RangeFilterDefaultValue event's data class is RangeFilterDefaultValueEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| ArgumentDateTimeGroupInterval | Gets the date-time group interval applied to the Range Filter argument. |
| ArgumentType | Gets the type of Range Filter’s argument values. |
| DashboardItemName | Gets the component name of the Range Filter for which the event was raised. |
| Range | Gets or sets the selected range for the current Range Filter dashboard item. |
Use the RangeFilterDefaultValueEventArgs.DashboardItemName event parameter to get the component name of the Range Filter item that raises the event. The RangeFilterDefaultValueEventArgs.Range property allows you to specify the selected range.
To apply default filtering to other master filter items, handle the DashboardDesigner.MasterFilterDefaultValues event.
Important
This event is not raised in asynchronous mode. Use the SetInitialDashboardState event to set the default selected range. See Manage Dashboard State for more information about a dashboard state.
This example demonstrates how to initialize master filter in a dashboard loaded in the DashboardViewer control. The code for the DashboardDesigner control is the same, because the DashboardDesigner’s events have the same name and functionality.
The following code initializes master filter items:
DashboardViewer.RangeFilterDefaultValue event is used to select the specified date range in the Range Filter.Master filter initialization can apply one item’s master filter to another master filter item - a mutual filtering occurs. In that scenario, the MasterFilterDefaultValues event has limitations if the Neutral Filter mode is disabled.
using DevExpress.DashboardCommon;
using System;
using System.Linq;
namespace Dashboard_MFDefaultValues
{
public partial class Form1 : DevExpress.XtraEditors.XtraForm {
public Form1() {
InitializeComponent();
dashboardViewer1.UseNeutralFilterMode = true;
dashboardViewer1.ConfigureDataConnection += DashboardViewer1_ConfigureDataConnection;
dashboardViewer1.MasterFilterDefaultValues += DashboardViewer1_MasterFilterDefaultValues;
dashboardViewer1.RangeFilterDefaultValue += DashboardViewer1_RangeFilterDefaultValue;
dashboardViewer1.Dashboard = new Dashboard1();
}
private void DashboardViewer1_ConfigureDataConnection(object sender, DashboardConfigureDataConnectionEventArgs e)
{
ExtractDataSourceConnectionParameters connParameters = e.ConnectionParameters as ExtractDataSourceConnectionParameters;
connParameters.FileName = "Data\\SalesPerson.dat";
}
private void DashboardViewer1_MasterFilterDefaultValues(object sender, MasterFilterDefaultValuesEventArgs e) {
if (e.ItemComponentName == "gridDashboardItem1") {
e.FilterValues = e.AvailableFilterValues.Where(v => (string)v["Sales Person"] == "Laura Callahan");
}
if (e.ItemComponentName == "treeViewDashboardItem1") {
e.FilterValues = e.AvailableFilterValues.Where(v => (string)v["Category"] == "Beverages" ||
(string)v["Product"] == "Aniseed Syrup");
}
}
private void DashboardViewer1_RangeFilterDefaultValue(object sender, RangeFilterDefaultValueEventArgs e) {
if (e.DashboardItemName == "rangeFilterDashboardItem1") {
e.Range = new RangeFilterSelection(new DateTime(2015, 06, 01), new DateTime(2016, 04, 01));
}
}
}
}
Imports DevExpress.DashboardCommon
Imports System
Imports System.Linq
Namespace Dashboard_MFDefaultValues
Public Partial Class Form1
Inherits DevExpress.XtraEditors.XtraForm
Public Sub New()
InitializeComponent()
dashboardViewer1.UseNeutralFilterMode = True
AddHandler dashboardViewer1.ConfigureDataConnection, AddressOf DashboardViewer1_ConfigureDataConnection
AddHandler dashboardViewer1.MasterFilterDefaultValues, AddressOf DashboardViewer1_MasterFilterDefaultValues
AddHandler dashboardViewer1.RangeFilterDefaultValue, AddressOf DashboardViewer1_RangeFilterDefaultValue
dashboardViewer1.Dashboard = New Dashboard1()
End Sub
Private Sub DashboardViewer1_ConfigureDataConnection(ByVal sender As Object, ByVal e As DashboardConfigureDataConnectionEventArgs)
Dim connParameters As ExtractDataSourceConnectionParameters = TryCast(e.ConnectionParameters, ExtractDataSourceConnectionParameters)
connParameters.FileName = "Data\SalesPerson.dat"
End Sub
Private Sub DashboardViewer1_MasterFilterDefaultValues(ByVal sender As Object, ByVal e As MasterFilterDefaultValuesEventArgs)
If Equals(e.ItemComponentName, "gridDashboardItem1") Then
e.FilterValues = e.AvailableFilterValues.Where(Function(v) Equals(CStr(v("Sales Person")), "Laura Callahan"))
End If
If Equals(e.ItemComponentName, "treeViewDashboardItem1") Then
e.FilterValues = e.AvailableFilterValues.Where(Function(v) Equals(CStr(v("Category")), "Beverages") OrElse Equals(CStr(v("Product")), "Aniseed Syrup"))
End If
End Sub
Private Sub DashboardViewer1_RangeFilterDefaultValue(ByVal sender As Object, ByVal e As RangeFilterDefaultValueEventArgs)
If Equals(e.DashboardItemName, "rangeFilterDashboardItem1") Then
e.Range = New RangeFilterSelection(New DateTime(2015, 06, 01), New DateTime(2016, 04, 01))
End If
End Sub
End Class
End Namespace
See Also