Skip to main content

Dashboards Module

  • 4 minutes to read

The Dashboards Module integrates DevExpress Dashboard controls into ASP.NET Core Blazor, Windows Forms, and ASP.NET Web Forms XAF applications.


You can find a Dashboards Module demo in the Dashboards section of the Feature Center application. The default location of the application is %PUBLIC%\Documents\DevExpress Demos 23.1\Components\XAF\FeatureCenter.NETFramework.XPO.

Dashboards Module Capabilities

For users

For developers

  • 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 View.
  • Create 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.


The DashboardView and Dashboard Module are different XAF concepts. Dashboard Views display multiple XAF Views in a single Frame - they do not use DevExpress Dashboard controls.

Dashboards Module Components


Platform Module NuGet package
Platform-agnostic DashboardsModule DevExpress.ExpressApp.Dashboards
WinForms DashboardsWindowsFormsModule DevExpress.ExpressApp.Dashboards.Win
ASP.NET Web Forms DashboardsAspNetModule DevExpress.ExpressApp.Dashboards.Web
ASP.NET Core Blazor DashboardsBlazorModule DevExpress.ExpressApp.Dashboards.Blazor

Integrated DevExpress Controls

ASP.NET Core Blazor
Windows Forms
ASP.NET Web Forms


You cannot localize the ASPxDashboard control in the Model Editor because it does not have a corresponding Localizer Object. For more information, refer to the following help topic: Dashboard | Localization.

View Items

The Dashboards Module uses the following View Items to host dashboard controls in ASP.NET Core Blazor, Windows Forms, and ASP.NET Web Forms XAF applications:

Application Model Extensions

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

Dashboard Data Type

The Module uses the following built-in business objects (entities) that implement the IDashboardData interface to store dashboards:

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


To display the DashboardData object’s Detail View, use the technique listed in the following help topic: Ways to Show a View.

Add the Dashboards Module to Your Application

Use either of the following techniques to add the Dashboards Module:


Make sure that you installed the appropriate platform-specific NuGet package.

The following additional steps may be required:

Entity Framework Core-Based Application

  1. Navigate to the MySolution.Module\BusinessObjects\MySolutionDbContext.cs file and include the DashboardData entity in the data model:

    using DevExpress.Persistent.BaseImpl.EF;
    // ...
    public class MySolutionEFCoreDbContext : DbContext {
        // ...
        public DbSet<DashboardData> DashboardData { get; set; }
        // ...
  2. Navigate to the MySolution.Blazor.Server\Startup.cs file (ASP.NET Core Blazor) or the MySolution.Win\Startup.cs file (Windows Forms) and specify the DashboardDataType explicitly:

    // ...
        .AddDashboards(options => {
            options.DashboardDataType = typeof(DevExpress.Persistent.BaseImpl.EF.DashboardData);

ASP.NET Core Blazor Application Without Application Builder

  1. Open the following file: MySolution.Blazor.Server\Startup.cs.

  2. In the Startup.ConfigureServices method, call the AddXafDashboards method to register Dashboards Module services.

  3. In the Startup.Configure method, call the MapXafDashboards method to configure endpoints for the Dashboards Module.

    using DevExpress.ExpressApp.Dashboards.Blazor;
    // ...
    public class Startup {
        // ...
        public void ConfigureServices(IServiceCollection services){
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env) {
            // ...
            app.UseEndpoints(endpoints => {
                // ...


For more information on how to resolve problems that can occur when you use the Dashboards Module, refer to the following topic: Dashboards Module Troubleshooting Guide.

See Also