DashboardConfigurator Class

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v18.2.Web.dll

Declaration

public class DashboardConfigurator :
    IDashboardServiceProvider,
    IExportDocumentCustomizationService,
    IDataEventsProvider,
    IFillDataSourceEventsProvider,
    IDataSourceKeyEventsProvider,
    IServiceDataConnectionParametersProvider,
    IServiceCustomParametersProvider,
    ICustomPaletteProvider,
    IDataSourceLifeCycleConfigurator,
    IDataServiceConfigurator,
    ICustomizeItemDataCalculationService,
    IDashboardCustomizationService,
    IDashboardCustomizationProvider,
    IClientTrustLevelVerification,
    IDataSourceWizardCustomizationProvider
Public Class DashboardConfigurator
    Implements IDashboardServiceProvider,
               IExportDocumentCustomizationService,
               IDataEventsProvider,
               IFillDataSourceEventsProvider,
               IDataSourceKeyEventsProvider,
               IServiceDataConnectionParametersProvider,
               IServiceCustomParametersProvider,
               ICustomPaletteProvider,
               IDataSourceLifeCycleConfigurator,
               IDataServiceConfigurator,
               ICustomizeItemDataCalculationService,
               IDashboardCustomizationService,
               IDashboardCustomizationProvider,
               IClientTrustLevelVerification,
               IDataSourceWizardCustomizationProvider

Remarks

Important

To learn how to use the DashboardConfigurator's API, see the Server-Side API Overview topic.

To prepare the ASPxDashboard/MVCxDashboard for first use, you need to create the dashboard and data sources storages.

  1. Use the static DashboardConfigurator.SetDashboardStorage method to create a storage that will contain dashboards. You can use predefined dashboard storages (DashboardFileStorage or DashboardInMemoryStorage) or you can implement the IDashboardStorage interface to provide your own logic for managing dashboards.
    Note

    The DashboardConfigurator uses the DashboardInMemoryStorage if you do not create the dashboard storage.

  2. Prepare data sources that will be used to supply dashboards with data. You can do this in two ways.

The DashboardConfigurator class also exposes an API used to supply the dashboard with data at runtime (for instance, using the DashboardConfigurator.ConfigureDataConnection or DashboardConfigurator.DataLoading events).

The following example shows how to set up ASPxDashboard with the DashboardConfigurator settings.

Set the UseDashboardConfigurator property to true and use the DashboardConfigurator to process data-related operations and handle data-related events (set the dashboard /data source storage, specify a connection provider, etc).

<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Default.aspx.cs" Inherits="WebFormsDashboardConfigurator.Default" %>

<%@ Register Assembly="DevExpress.Web.v18.2, Version=18.2.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" Namespace="DevExpress.Web" TagPrefix="dx" %>

<%@ Register Assembly="DevExpress.Dashboard.v18.2.Web.WebForms, Version=18.2.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" Namespace="DevExpress.DashboardWeb" TagPrefix="dx" %>

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title>Web Dashboard</title>
</head>
<body>
    <form id="form1" runat="server">
        <div style="position: absolute; left: 0; right: 0; top:0; bottom:0;">
            <dx:ASPxDashboard ID="ASPxDashboard1" runat="server" Width="100%" Height="100%"  ClientInstanceName="webDashboard">
            </dx:ASPxDashboard>
        </div>
    </form>
</body>
</html>

Inheritance

Object
DashboardConfigurator

Implements

DevExpress.DashboardWeb.Native.IDashboardServiceProvider
DevExpress.DashboardCommon.Native.DashboardRestfulService.IExportDocumentCustomizationService
DevExpress.DashboardCommon.Native.DashboardRestfulService.IDataEventsProvider
DevExpress.DashboardCommon.Native.DashboardRestfulService.IFillDataSourceEventsProvider
DevExpress.DashboardCommon.Native.DashboardRestfulService.IDataSourceKeyEventsProvider
DevExpress.DashboardCommon.Native.DashboardRestfulService.IServiceDataConnectionParametersProvider
DevExpress.DashboardCommon.Native.DashboardRestfulService.IServiceCustomParametersProvider
DevExpress.DashboardCommon.Native.DashboardRestfulService.ICustomPaletteProvider
DevExpress.DashboardCommon.Native.DashboardRestfulService.IDataSourceLifeCycleConfigurator
DevExpress.DashboardCommon.Native.DashboardRestfulService.IDataServiceConfigurator
DevExpress.DashboardCommon.Native.DashboardRestfulService.ICustomizeItemDataCalculationService
DevExpress.DashboardCommon.Native.DashboardRestfulService.IDashboardCustomizationService
DevExpress.DashboardCommon.Native.DashboardRestfulService.IDashboardCustomizationProvider
DevExpress.DashboardWeb.Native.IClientTrustLevelVerification
DevExpress.DashboardWeb.Native.IDataSourceWizardCustomizationProvider
See Also