[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)

Dashboards Module Overview

The Dashboards Module allows you to integrate DevExpress Dashboard controls with WinForms and ASP.NET XAF applications.


The Dashboards Module is demonstrated in the Dashboards section of the Feature Center application. The Feature Center demo is installed in %PUBLIC%\Documents\DevExpress Demos 19.1\Components\eXpressApp Framework\FeatureCenter by default. The ASP.NET version of this demo is available online at http://demos.devexpress.com/XAF/FeatureCenter/.

Expanded Dashboards Module Capabilities

For end-user:

For developer:

  • Create dashboards at runtime and persist them. Dashboards are stored with other business objects in the application database.
  • View and modify existing dashboards in the Dashboards List View. You can use the Dashboards navigation item to invoke this List View.
  • Provide predefined dashboards that are available to users after an application's deployment.
  • Create navigation items associated with individual dashboards.
  • Customize the dashboard's control options and behavior.

Note that the DashboardView Views and Dashboard Module are different XAF concepts. Dashboard Views display several XAF Views in a single Frame - they do not utilize DevExpress Dashboard controls.

Expanded DevExpress Controls Used by the Dashboards Module


The ASPxDashboard control cannot be localized in the Model Editor as it does not have a corresponding Localizer Object. See Dashboard | Localization for more information.

Expanded Dashboards Module Components


The Dashboards Module provides the following View Items used to host dashboard controls in WinForms and ASP.NET applications:

The Dashboards Module extends the Application Model - introduces the IModelDashboardNavigationItem node and adds the IModelClassDashboardsVisibility.IsVisibleInDashboards property to the IModelClass node.

Expanded Dashboard Data Type

Dashboards are persisted using business objects (entities) that implement the IDashboardData interface. If you are using XPO, the DashboardData persistent class implemented in the Business Class Library is used. If you use the Entity Framework, set the DashboardsModule.DashboardDataType property to DashboardData manually and add this type to your DBContext.

You can also use a custom dashboard data type. To do this, inherit DashboardData or implement the IDashboardData interface and pass the implemented type to the DashboardsModule.DashboardDataType property.


To display a dashboard in code, use an approach listed in the Ways to Show a View topic to show the DashboardData object's Detail View.

Expanded See Also

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