DashboardDesigner.Dashboard Property

Gets or sets the currently opened dashboard.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v24.1.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 an instance of the Dashboard class to the Dashboard property.
• Use the DashboardDesigner.LoadDashboard or Dashboard.LoadFromXml methods to open a dashboard from an XML file.

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-grid-hyperlink-column/CS/Dashboard_GridHyperlinkColumn/Form1.cs#L34

    dashboard.Items.Add(grid);
    dashboardDesigner1.Dashboard = dashboard;
}

winforms-dashboard-sql-data-source/CS/Dashboard_DashboardDataProviders/Form1.cs#L17

    sqlDataSource.Fill();
    dashboardDesigner1.Dashboard = CreateDashboard(sqlDataSource);
}

winforms-dashboard-customize-color-scheme/CS/Dashboard_Coloring/Form1.cs#L29

    }
    dashboardDesigner1.Dashboard = dashboard;
}

winforms-dashboard-designer-merge-dashboards-to-tabs/CS/DesignerForm.cs#L38

// The DashboardMerger instance is the key object that performs the merge.
DashboardMerger dashboardMerger = new DashboardMerger(dashboardDesigner.Dashboard);
if(!dashboardMerger.MergeDashboard(dashboard)) {

winforms-dashboard-filtering-in-olap-mode/CS/Dashboard_OlapFiltering/Form1.cs#L39

    pivot1.FilterString = filterCriteria.ToString();
    dashboardDesigner1.Dashboard = dashboard;
}

VB.NET

winforms-dashboard-grid-hyperlink-column/VB/Dashboard_GridHyperlinkColumn/Form1.vb#L29

    dashboard.Items.Add(grid)
    dashboardDesigner1.Dashboard = dashboard
End Sub

winforms-dashboard-sql-data-source/VB/Dashboard_DashboardDataProviders/Form1.vb#L17

    sqlDataSource.Fill()
    dashboardDesigner1.Dashboard = CreateDashboard(sqlDataSource)
End Sub

winforms-dashboard-customize-color-scheme/VB/Dashboard_Coloring/Form1.vb#L32

    Next row
    dashboardDesigner1.Dashboard = dashboard
End Sub

winforms-dashboard-designer-merge-dashboards-to-tabs/VB/DesignerForm.vb#L39

' The DashboardMerger instance is the key object that performs the merge.
Dim dashboardMerger As New DashboardMerger(dashboardDesigner.Dashboard)
If Not dashboardMerger.MergeDashboard(dashboard) Then

winforms-dashboard-filtering-in-olap-mode/VB/Dashboard_OlapFiltering/Form1.vb#L36

    pivot1.FilterString = filterCriteria.ToString()
    dashboardDesigner1.Dashboard = dashboard
End Sub

Implements

Dashboard