DashboardControl Class

A control used to embed dashboards created in the Dashboard Designer into a WPF application.

Assembly: DevExpress.Dashboard.v24.1.Wpf.dll

NuGet Package: DevExpress.Wpf.Dashboard

Declaration

C#
VB.NET

[DXToolboxBrowsable]
public class DashboardControl :
    DashboardControlBase,
    IDataEventsProvider,
    IFillDataSourceEventsProvider,
    IDataSourceKeyEventsProvider,
    IDataServiceConfigurator,
    IServiceDataConnectionParametersProvider,
    IDataSessionConsumer,
    IDataSourceLifeCycleConfigurator,
    ICustomPaletteProvider,
    ICustomizeItemDataCalculationService,
    IExportDocumentCustomizationService,
    IDashboardCustomizationService,
    IDashboardCustomizationProvider,
    IContentArrangerProvider,
    IDashboardControlProvider,
    IErrorHandler,
    IDashboardViewer,
    IControlActionInvoker,
    IDashboardInteractivityItemProvider,
    ISelectedTabPageProvider,
    IServiceCustomParametersProvider,
    IServiceProvider,
    IDashboardDataSourceSettingsProvider,
    IDashboardParametersProvider,
    IDashboardDataService,
    ISupportDashboardParallelMode

<DXToolboxBrowsable>
Public Class DashboardControl
    Inherits DashboardControlBase
    Implements IDataEventsProvider,
               IFillDataSourceEventsProvider,
               IDataSourceKeyEventsProvider,
               IDataServiceConfigurator,
               IServiceDataConnectionParametersProvider,
               IDataSessionConsumer,
               IDataSourceLifeCycleConfigurator,
               ICustomPaletteProvider,
               ICustomizeItemDataCalculationService,
               IExportDocumentCustomizationService,
               IDashboardCustomizationService,
               IDashboardCustomizationProvider,
               IContentArrangerProvider,
               IDashboardControlProvider,
               IErrorHandler,
               IDashboardViewer,
               IControlActionInvoker,
               IDashboardInteractivityItemProvider,
               ISelectedTabPageProvider,
               IServiceCustomParametersProvider,
               IServiceProvider,
               IDashboardDataSourceSettingsProvider,
               IDashboardParametersProvider,
               IDashboardDataService,
               ISupportDashboardParallelMode

Remarks

The DashboardControl control allows you to embed a dashboard into a WPF application. To learn how to build a Dashboard Viewer application using the DashboardControl, see the following sections:

Important

Note that the DashboardControl control does not support .NET Framework 4.0 Client Profile. To learn how to target a version of the .NET Framework, see How to: Target a Version of the .NET Framework.

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardControl class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

wpf-dashboard-linked-interactivity/CS/WpfDashboard_LinkedInteractivity/ChildWindow.xaml#L12


<dxdash:DashboardControl x:Name="childDashboardControl" MinHeight="150"/>

wpf-dashboard-how-to-bind-to-object-list/CS/WpfDashboard_ObjectDataSource/MainWindow.xaml#L23


<dxdash:DashboardControl
    x:Name="dashboardControl"

wpf-dashboard-how-to-obtain-item-data-on-mouse-hover/CS/Dashboard_UnderlyingDataWPF/MainWindow.xaml#L17

<Grid>
    <dxdash:DashboardControl
        MinHeight="150"

wpf-dashboard-how-to-obtain-clicked-item-data/CS/Dashboard_ClientDataCards_Wpf/MainWindow.xaml#L12


<dxdash:DashboardControl DashboardSource="{x:Type local:Dashboard1}" DashboardItemMouseUp="DashboardControl_DashboardItemMouseUp"/>

wpf-dashboard-how-to-embed-devexpress-control/CS/GanttSample/Window.xaml#L44

<Grid>
    <dxdash:DashboardControl DashboardSource="{x:Type local:Dashboard}"
                             ObjectDataSourceLoadingBehavior="LoadAsIs"