[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Report and Dashboard Server
[Collapse]eXpressApp Framework
 [Expand]Getting Started
  [Expand]Application Solution Components
  [Expand]Business Model Design
  [Expand]Application Model
  [Expand]UI Construction
  [Expand]Controllers and Actions
  [Expand]Data Manipulation and Business Logic
  [Expand]Security System
  [Expand]System Module
  [Collapse]Extra Modules
   [Expand]Audit Trail Module
    Business Class Library Customization Module
    Chart Module
    Clone Object Module
   [Expand]Conditional Appearance Module
   [Collapse]Dashboards Module
     Dashboards Module Overview
     Create, View and Modify Dashboards in a WinForms Application
     Create, View and Modify Dashboards in an ASP.NET Application
     Create a Predefined Dashboard and Add it to the Navigation
     Dashboard Performance With Large Data Sources
    File Attachments Module
    HTML Property Editor Module
    Localization Module
   [Expand]Notifications Module
    KPI Module
   [Expand]Maps Module
   [Expand]Pivot Chart Module
    Pivot Grid Module
   [Expand]Reports V2 Module
   [Expand]Reports Module (Obsolete)
   [Expand]Office Module
   [Expand]Scheduler Module
    Script Recorder Module
   [Expand]State Machine Module
   [Expand]TreeList Editors Module
   [Expand]Validation Module
    View Variants Module
   [Expand]Workflow Module
  [Expand]Debugging, Testing and Error Handling
  [Expand]Application Life Cycle
 [Expand]Design-Time Features
 [Expand]Task-Based Help
  Frequently Asked Questions (FAQ)
 [Expand]API Reference
[Expand]eXpress Persistent Objects
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

Create a Predefined Dashboard and Add it to the Navigation

This topic describes how to provide a predefined dashboard that is available to users immediately after application deployment.

  • Create a dashboard at runtime. You can review the following topics to learn how to do it.

  • Save the dashboard to an XML file.

    • In a WinForms application, you can use the Save As button in the Dashboard Designer.

    • In an ASP.NET application, you can click Export To | XML File when viewing the dashboard.

  • Add the created XML file to the module project as a resource file.

  • Open the Updater.cs (Updater.vb) file and add the following code to the ModuleUpdater.UpdateDatabaseAfterUpdateSchema method.

  • Run the Model Editor. To add the dashboard to a certain navigation group, right-click its Items child node and choose Add... | DashboardNavigationItem.

  • Focus the created node and set the IModelDashboardNavigationItem.DashboardTitle property to the title of the required dashboard.


    As the dashboard is identified by its title, do not change the title after the navigation item is added.

  • Run the application to ensure that the dashboard is added to the navigation.


If you are going to use predefined dashboards only, you can remove the Dashboards List View from the navigation. Set the DashboardsModule.GenerateNavigationItem property to false for this purpose.

Is this topic helpful?​​​​​​​