Dashboards Module Overview

The Dashboards Module is introduced to simplify the integration of DevExpress Dashboard controls with WinForms and ASP.NET XAF applications.

Dashboards_XCRM

Tip

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

Dashboards Module Capabilities

For end-user:

For developer:

  • Create dashboards at runtime and persist them. Dashboards are stored together with other business objects in the application database.
  • View and modify the existing dashboards in the Dashboards List View, which can be invoked from the Dashboards navigation item.
  • Provide predefined dashboards that are available to users immediately after application deployment.
  • Create navigation items associated with individual dashboards.
  • Customize the dashboard's control options and behavior.
Note

Do not mix dashboards described here with the DashboardView Views. Dashboard Views simply display several XAF Views in a single Frame, they do not utilize controls provided by DevExpress Dashboard.

DevExpress Controls Used by the Dashboards Module

Note

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

Dashboards Module Components

Dashboards_Toolbox

Note

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.

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 automatically. If you use the Entity Framework, manually set the DashboardsModule.DashboardDataType property to DashboardData and add this type to your DBContext.

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

See Also