Dashboards Module Overview
The Dashboards Module is introduced to simplify the integration of DevExpress Dashboard controls with WinForms and ASP.NET XAF applications.
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
DevExpress Controls Used by the Dashboards Module
- DashboardDesigner - used to design dashboards in a WinForms application.
- DashboardViewer - used to view dashboards in a WinForms application.
- ASPxDashboard - used to view and create dashboards in an ASP.NET application.
Dashboards Module Components
- DashboardsModule - add it to your platform-agnostic module in the Module Designer.
- DashboardsWindowsFormsModule - add it to your WinForms application project in the Application Designer.
- DashboardsAspNetModule - add it to your ASP.NET application project in the Application Designer.
You can add a module in the Solution Wizard when creating a new XAF solution by selecting a module in the Choose Extra Modules step.
- To add an extra module in code, add it to the XafApplication.Modules or ModuleBase.RequiredModuleTypes list (adding a reference to the module assembly is insufficient).
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.