DashboardViewer.Dashboard Property

Gets or sets the currently opened dashboard.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v23.2.Win.dll

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

[Browsable(false)]
public Dashboard Dashboard { get; set; }

VB.NET

<Browsable(False)>
Public Property Dashboard As Dashboard

Property Value

Type	Description
Dashboard	A Dashboard object that is the currently opened dashboard.

Remarks

You can open a dashboard in one of the following ways.

• Create and assign the Dashboard class instance to the Dashboard property. Note that in this case, you need to dispose the dashboard instance to avoid a memory leak.
• Specify the dashboard using the DashboardViewer.DashboardSource property.
• Use the DashboardViewer.LoadDashboard method to open a dashboard from a file or stream.

All these actions raise the DashboardViewer.DashboardChanged event.

Note

You cannot use the same instance of the dashboard object in the DashboardDesigner and DashboardViewer controls at the same time. You can use the SaveToXml / LoadFromXml methods to create a copy of the dashboard object.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Dashboard 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#

winforms-dashboard-apply-conditional-formatting-to-grid-cells/CS/Dashboard_ConditionalFormatting_Grid/BarConditionForm.cs#L8

Dashboard dashboard = new Dashboard(); dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");
dashboardViewer1.Dashboard = dashboard;
GridDashboardItem grid = (GridDashboardItem)dashboard.Items["gridDashboardItem1"];

winforms-dashboard-create-layout-from-scratch/CS/Dashboard_LayoutCustomization/Form1.cs#L62

    dashboardViewer1.Dashboard = dashboard;
}

winforms-dashboard-bind-chart-item-to-data-in-code/CS/Dashboard_CreateChart/Form1.cs#L40

// Creates a dashboard and sets it as the currently opened dashboard in the dashboard viewer.
dashboardViewer1.Dashboard = new Dashboard();

winforms-dashboard-pass-dashboard-parameters-to-expression-format-condition-in-code/CS/Dashboard_ConditionalFormatting_Grid/Form1.cs#L8

Dashboard dashboard = new Dashboard(); dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");
dashboardViewer1.Dashboard = dashboard;
GridDashboardItem grid = (GridDashboardItem)dashboard.Items["gridDashboardItem1"];

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/CS/ShowDetailViewFromDashboard.Module.Win/Controllers/WinShowDetailViewFromDashboardController.cs#L46

private void Viewer_DashboardItemDoubleClick(object sender, DashboardItemMouseActionEventArgs e) {
    Dashboard dashboard = ((DashboardViewer)sender).Dashboard;
    if (IsGridDashboardItem(dashboard, e.DashboardItemName) &&

VB.NET

winforms-dashboard-apply-conditional-formatting-to-grid-cells/VB/Dashboard_ConditionalFormatting_Grid/BarConditionForm.vb#L12

dashboard.LoadFromXml("..\..\Data\Dashboard.xml")
dashboardViewer1.Dashboard = dashboard
Dim grid As GridDashboardItem = CType(dashboard.Items("gridDashboardItem1"), GridDashboardItem)

winforms-dashboard-create-layout-from-scratch/VB/Dashboard_LayoutCustomization/Form1.vb#L50

    dashboardViewer1.Dashboard = dashboard
End Sub

winforms-dashboard-bind-chart-item-to-data-in-code/VB/Dashboard_CreateChart/Form1.vb#L42

' Creates a dashboard and sets it as the currently opened dashboard in the dashboard viewer.
dashboardViewer1.Dashboard = New Dashboard()

winforms-dashboard-pass-dashboard-parameters-to-expression-format-condition-in-code/VB/Dashboard_ConditionalFormatting_Grid/Form1.vb#L11

dashboard.LoadFromXml("..\..\Data\Dashboard.xml")
dashboardViewer1.Dashboard = dashboard
Dim grid As GridDashboardItem =

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/VB/ShowDetailViewFromDashboard.Module.Win/Controllers/WinShowDetailViewFromDashboardController.vb#L48

Private Sub Viewer_DashboardItemDoubleClick(ByVal sender As Object, ByVal e As DashboardItemMouseActionEventArgs)
    Dim dashboard As Dashboard = DirectCast(sender, DashboardViewer).Dashboard
    Dim oid As Object

Implements

Dashboard