Loading a Dashboard
- 2 minutes to read
Important
This documentation applies to v16.2. Starting with v17.1, the ASPxDashboardViewer control is in maintenance mode. In v19.1, the new Web Dashboard Control replaces the old Web Dashboard Viewer. This means that the Web Dashboard Viewer will not be included in our installation packages. See our blog post for more information.
Refer to the following KB articles to learn how to migrate to ASPxDashboard / ASP.NET MVC Dashboard:
ASPxDashboardViewer -> ASPxDashboard
How to migrate from ASPxDashboardViewer to ASPxDashboard working in the ViewerOnly mode
MVCxDashboardViewer -> MVCxDashboard
How to migrate from DashboardViewerExtension to DashboardExtension working in the ViewerOnly mode
You can use one of the following approaches to load the dashboard to the ASPxDashboardViewer.
Create a dashboard in the DashboardDesigner and save its definition to an XML file. To open the saved dashboard, click the ASPxDashboardViewer‘s smart tag button. In the invoked tasks panel, click the Dashboard Source drop-down arrow, expand the Project Xml Files folder, and select the required XML file.
In code, use the ASPxDashboardViewer.DashboardSource property to specify the path to the dashboard XML file.
Create a dashboard in the Visual Studio Dashboard Designer. To open the project dashboard, click the control’s smart tag button and select the dashboard from Project Dashboards in the Dashboard Source drop-down menu.
You can assign the type of the created dashboard to the ASPxDashboardViewer.DashboardSource property.
- To load a dashboard at runtime, assign a unique dashboard identifier to the ASPxDashboardViewer.DashboardId property and handle the ASPxDashboardViewer.DashboardLoading event, to supply the dashboard XML definition.