DashboardViewer Class

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

Assembly: DevExpress.Dashboard.v19.1.Win.dll

Declaration

C#
VB.NET

[ToolboxTabName("DX.19.1: Data & Analytics")]
[ToolboxBitmap(typeof(ResFinder), "Bitmaps256.DashboardViewer.bmp")]
public class DashboardViewer :
    DashboardUserControl,
    IDataSourceEventsProvider,
    ISupportInitialize,
    IOfficeCoreReference,
    IXtraChartsWizardReference,
    IDashboardExportUIProvider,
    IExportOptionsOwner,
    IDashboardExportItem,
    IUnderlyingControlProvider,
    IClientSideApi,
    IDXMenuManagerProvider,
    ISupportXtraAnimation,
    IDashboardControl,
    IDataEventsProvider,
    IFillDataSourceEventsProvider,
    IDataSourceKeyEventsProvider,
    IDataServiceConfigurator,
    IDataSourceLifeCycleConfigurator,
    IServiceDataConnectionParametersProvider,
    ICustomPaletteProvider,
    IActualParametersProvider,
    IServiceCustomParametersProvider,
    ICustomizeItemDataCalculationService,
    IExportDocumentCustomizationService,
    IDataSessionConsumer,
    IDashboardCustomizationService,
    IColoringCacheProvider,
    IDataServiceProvider

<ToolboxTabName("DX.19.1: Data & Analytics")>
<ToolboxBitmap(GetType(ResFinder), "Bitmaps256.DashboardViewer.bmp")>
Public Class DashboardViewer
    Inherits DashboardUserControl
    Implements IDataSourceEventsProvider,
               ISupportInitialize,
               IOfficeCoreReference,
               IXtraChartsWizardReference,
               IDashboardExportUIProvider,
               IExportOptionsOwner,
               IDashboardExportItem,
               IUnderlyingControlProvider,
               IClientSideApi,
               IDXMenuManagerProvider,
               ISupportXtraAnimation,
               IDashboardControl,
               IDataEventsProvider,
               IFillDataSourceEventsProvider,
               IDataSourceKeyEventsProvider,
               IDataServiceConfigurator,
               IDataSourceLifeCycleConfigurator,
               IServiceDataConnectionParametersProvider,
               ICustomPaletteProvider,
               IActualParametersProvider,
               IServiceCustomParametersProvider,
               ICustomizeItemDataCalculationService,
               IExportDocumentCustomizationService,
               IDataSessionConsumer,
               IDashboardCustomizationService,
               IColoringCacheProvider,
               IDataServiceProvider

The following members accept/return DashboardViewer objects:

Remarks

The DashboardViewer control allows you to embed a dashboard into a WinForms application. The following documentation is available for the WinForms Viewer.

Getting Started - Create a WinForms Viewer for Displaying a Dashboard

Shows how to create the Dashboard Viewer application and use this application to display the existing dashboard.
Building the Viewer Application

Describes how to prepare the Dashboard Viewer application and customize its UI elements.

Important

Note that the DashboardViewer 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 DashboardViewer 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.

C#
VB.NET

how-to-print-and-export-a-winforms-dashboard-visual-representation-as-is-e4399/CS/DashboardExport/DashboardExporter.cs#L13

PrintableComponentLink componentLink = new PrintableComponentLink();
DashboardViewer viewer;
bool paged;

winforms-dashboard-how-to-customize-the-dashboard-title-and-dashboard-item-captions-t630210/CS/CustomizeDashboardItemCaptionExample/ViewerForm1.cs#L27

private void DashboardViewer_CustomizeDashboardTitle(object sender, CustomizeDashboardTitleEventArgs e) {
    DashboardViewer viewer = (DashboardViewer)sender;

win-dashboard-viewer-chartcontrol-checkedlegend-maximized/CS/CheckBoxLegendExample/CheckBoxLegend/ChartLegendHelper.cs#L12

{
    DashboardViewer viewer;
    DashboardDesigner designer;

how-to-apply-master-filtering-in-dashboardviewer-e5097/CS/Dashboard_SetMasterFilter/Form1.cs#L46

{
    DashboardViewer viewer = (DashboardViewer)sender;
    // If the Master Filter includes Anne Dodsworth as Sales Person, disable print and export.

winforms-dashboard-viewer-item-tabs/CS/TabSupportExample/Form1.cs#L124

{
    Dashboard dashboard = ((DashboardViewer)sender).Dashboard;

how-to-print-and-export-a-winforms-dashboard-visual-representation-as-is-e4399/VB/DashboardExport/DashboardExporter.vb#L15

Private componentLink As New PrintableComponentLink()
Private viewer As DashboardViewer
Private paged As Boolean

winforms-dashboard-how-to-customize-the-dashboard-title-and-dashboard-item-captions-t630210/VB/CustomizeDashboardItemCaptionExample/ViewerForm1.vb#L30

Private Sub DashboardViewer_CustomizeDashboardTitle(ByVal sender As Object, ByVal e As CustomizeDashboardTitleEventArgs)
    Dim viewer As DashboardViewer = DirectCast(sender, DashboardViewer)

win-dashboard-viewer-chartcontrol-checkedlegend-maximized/VB/CheckBoxLegendExample/CheckBoxLegend/ChartLegendHelper.vb#L10

Friend Class ChartLegendHelper
    Private viewer As DashboardViewer
    Private designer As DashboardDesigner

how-to-apply-master-filtering-in-dashboardviewer-e5097/VB/Dashboard_SetMasterFilter/Form1.vb#L46

Private Sub DashboardViewer1_MasterFilterSet(ByVal sender As Object, ByVal e As MasterFilterSetEventArgs)
    Dim viewer As DashboardViewer = DirectCast(sender, DashboardViewer)
    ' If the Master Filter includes Anne Dodsworth as Sales Person, disable print and export.

winforms-dashboard-viewer-item-tabs/VB/TabSupportExample/Form1.vb#L117

Private Sub DashboardViewer1_CustomizeDashboardItemCaption(ByVal sender As Object, ByVal e As CustomizeDashboardItemCaptionEventArgs)
    Dim dashboard As Dashboard = DirectCast(sender, DashboardViewer).Dashboard