DashboardViewer.DashboardLoaded Event

Occurs after the dashboard is loaded to the DashboardViewer.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v21.1.Win.dll

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public event DashboardLoadedEventHandler DashboardLoaded

VB.NET

Public Event DashboardLoaded As DashboardLoadedEventHandler

Event Data

The DashboardLoaded event's data class is DashboardLoadedEventArgs. The following properties provide information specific to this event:

Property	Description
Dashboard	Gets the loaded dashboard.

Remarks

The DashboardLoaded event is raised whenever a dashboard is loaded to the DashboardViewer.

Use the DashboardLoadedEventArgs.Dashboard event parameter to customize the dashboard before it is loaded to the DashboardViewer.

Example

The following example shows how to specify default parameter values when a dashboard is loading. To do this, handle the DashboardViewer.SetInitialDashboardState event. Create a DashboardParameterState instance and use its Name and Value properties to configure parameter values. Create a DashboardState object and add the specified dashboard parameter to the DashboardState.Parameters collection. Assign the created DashboardState object to the SetInitialDashboardStateBaseEventArgs.InitialState property to apply specified parameter values when a dashboard is loading.

View Example

Form1.cs

using System.Collections.Generic;
using DevExpress.DashboardCommon;
using DevExpress.DashboardWin;
using DevExpress.DataAccess.ConnectionParameters;

namespace WinViewer_DefaultParameterValues {
    public partial class Form1 : DevExpress.XtraEditors.XtraForm {
        public Form1() {
            InitializeComponent();
        }
        private void dashboardViewer1_SetInitialDashboardState(object sender, SetInitialDashboardStateEventArgs e) {
            DashboardState state = new DashboardState();
            DashboardParameterState parameters = new DashboardParameterState();
            parameters.Name = "customerIdParameter";
            parameters.Value = new List<string>() { "ALFKI", "AROUT", "BONAP" };
            state.Parameters.Add(parameters);
            e.InitialState = state;
        }
        private void dashboardViewer1_ConfigureDataConnection(object sender, DashboardConfigureDataConnectionEventArgs e) {
            if (e.DataSourceName == "SQL Data Source 1")
                e.ConnectionParameters = new Access97ConnectionParameters(@"..\..\Data\nwind.mdb", "", "");
        }
    }
}

Form1.vb

Imports System.Collections.Generic
Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWin
Imports DevExpress.DataAccess.ConnectionParameters

Namespace WinViewer_DefaultParameterValues
    Partial Public Class Form1
        Inherits DevExpress.XtraEditors.XtraForm

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub dashboardViewer1_SetInitialDashboardState(ByVal sender As Object, ByVal e As SetInitialDashboardStateEventArgs)
            Dim state As New DashboardState()
            Dim parameters As New DashboardParameterState()
            parameters.Name = "customerIdParameter"
            parameters.Value = New List(Of String)() From {"ALFKI", "AROUT", "BONAP"}
            state.Parameters.Add(parameters)
            e.InitialState = state
        End Sub

        Private Sub dashboardViewer1_ConfigureDataConnection(ByVal sender As Object, ByVal e As DashboardConfigureDataConnectionEventArgs) Handles dashboardViewer1.ConfigureDataConnection
            If e.DataSourceName = "SQL Data Source 1" Then
                e.ConnectionParameters = New Access97ConnectionParameters("..\..\Data\nwind.mdb", "", "")
            End If
        End Sub
    End Class
End Namespace

Related GitHub Examples

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

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#

winforms-dashboard-save-restore-dashboard-state/CS/WinFormsDashboard_DashboardState/Form1.cs#L18

InitializeComponent();
dashboardViewer1.DashboardLoaded += DashboardViewer1_DashboardLoaded;
dashboardViewer1.SetInitialDashboardState += DashboardViewer1_SetInitialDashboardState;

winforms-viewer-save-and-apply-dashboard-state/CS/WinFormsViewerSaveAndApplyDashboarState/ViewerForm1.cs#L15

InitializeComponent();
dashboardViewer.DashboardLoaded += dashboardViewer_DashboardLoaded;
dashboardViewer.SetInitialDashboardState += dashboardViewer_SetInitialDashboardState;

VB.NET

winforms-dashboard-save-restore-dashboard-state/VB/WinFormsDashboard_DashboardState/Form1.vb#L17

InitializeComponent()
AddHandler dashboardViewer1.DashboardLoaded, AddressOf DashboardViewer1_DashboardLoaded
AddHandler dashboardViewer1.SetInitialDashboardState, AddressOf DashboardViewer1_SetInitialDashboardState

winforms-viewer-save-and-apply-dashboard-state/VB/WinFormsViewerSaveAndApplyDashboarState/ViewerForm1.vb#L15

InitializeComponent()
AddHandler dashboardViewer.DashboardLoaded, AddressOf dashboardViewer_DashboardLoaded
AddHandler dashboardViewer.SetInitialDashboardState, AddressOf dashboardViewer_SetInitialDashboardState

Implements

DashboardLoaded