DashboardViewer.Dashboard Property

Gets or sets the currently opened dashboard.

Namespace: DevExpress.DashboardWin

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

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.

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-viewer-item-tabs/CS/TabSupportExample/Form1.cs#L18

    dashboardViewer1.CustomizeDashboardItemCaption += DashboardViewer1_CustomizeDashboardItemCaption;
    dashboardViewer1.Dashboard = CreateSimpleDashboard();
}

how-to-customize-a-palette-of-the-choropleth-map-e5108/CS/Dashboard_ChoroplethMapCustomPalette/Form1.cs#L45

    // Sets the customized dashboard as a currently opened dashboard.
    dashboardViewer1.Dashboard = dashboard;
}

how-to-create-a-dashboard-layout-from-scratch-e5206/CS/Dashboard_LayoutCustomization/Form1.cs#L67

{
    Dashboard dashboard = dashboardViewer1.Dashboard;
    DashboardLayoutGroup rootGroup = dashboard.LayoutRoot.ChildNodes[0] as DashboardLayoutGroup;

how-to-print-and-export-a-winforms-dashboard-visual-representation-as-is-e4399/CS/DashboardExport/Form1.cs#L28

            ).CustomerSupport;
    dashboardViewer1.Dashboard = dashboard;
}

how-to-apply-conditional-formatting-to-grid-cells-using-the-date-occurring-format-condition-t267749/CS/Grid_DateOccurring/Form1.cs#L13

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

VB.NET

winforms-dashboard-viewer-item-tabs/VB/TabSupportExample/Form1.vb#L17

    AddHandler dashboardViewer1.CustomizeDashboardItemCaption, AddressOf DashboardViewer1_CustomizeDashboardItemCaption
    dashboardViewer1.Dashboard = CreateSimpleDashboard()
End Sub

how-to-create-a-dashboard-layout-from-scratch-e5206/VB/Dashboard_LayoutCustomization/Form1.vb#L54

Private Sub RepositionItems(ByVal args As DashboardToolbarItemClickEventArgs)
    Dim dashboard As Dashboard = dashboardViewer1.Dashboard
    Dim rootGroup As DashboardLayoutGroup = TryCast(dashboard.LayoutRoot.ChildNodes(0), DashboardLayoutGroup)

how-to-print-and-export-a-winforms-dashboard-visual-representation-as-is-e4399/VB/DashboardExport/Form1.vb#L26

    dashboard.DataSources(0).Data = (New CustomerSupportData(DataLoader.LoadCustomerSupport(), DataLoader.LoadEmployees())).CustomerSupport
    dashboardViewer1.Dashboard = dashboard
End Sub

how-to-apply-conditional-formatting-to-grid-cells-using-the-date-occurring-format-condition-t267749/VB/Grid_DateOccurring/Form1.vb#L15

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

how-to-bind-a-card-dashboard-item-to-data-in-code-e4770/VB/Dashboard_CreateCards/Form1.vb#L36

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