ASPxDashboard Class

A Web Dashboard control, which allows you to create new dashboards from scratch and display them to end-users.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v23.2.Web.WebForms.dll

NuGet Package: DevExpress.Web.Dashboard

Declaration

C#

[DXDocumentationProvider("Getting Started", "#Dashboard/CustomDocument115782")]
[ToolboxBitmap(typeof(ASPxDashboard), "Bitmaps256.ASPxDashboardDesigner.bmp")]
public class ASPxDashboard :
    ASPxWebClientUIControl,
    IJSONCustomObject,
    IDataSessionConsumer,
    IEventStorageProvider,
    IDashboardStateService

VB.NET

<ToolboxBitmap(GetType(ASPxDashboard), "Bitmaps256.ASPxDashboardDesigner.bmp")>
<DXDocumentationProvider("Getting Started", "#Dashboard/CustomDocument115782")>
Public Class ASPxDashboard
    Inherits ASPxWebClientUIControl
    Implements IJSONCustomObject,
               IDataSessionConsumer,
               IEventStorageProvider,
               IDashboardStateService

Related API Members

The following members return ASPxDashboard objects:

• WebDashboardViewerViewItem.DashboardControl
• WebDashboardViewerViewItem.DashboardDesigner

Remarks

The following code shows how to handle client and server events and set initial values of the extension’s properties:

<asp:Content ID="Content1" ContentPlaceHolderID="MainContent" runat="server">
<script type="text/javascript">
    function onBeforeRender(sender) {
        var control = sender.GetDashboardControl();
        control.registerExtension(new DevExpress.Dashboard.DashboardPanelExtension(control, { dashboardThumbnail: "./Content/DashboardThumbnail/{0}.png" }));
    }
</script>
    <dx:ASPxDashboard ID="ASPxDashboard1" runat="server" Width="100%" Height="100%" ondataloading="DataLoading" AllowInspectAggregatedData="true">
        <ClientSideEvents BeforeRender="onBeforeRender" />
    </dx:ASPxDashboard>
</asp:Content>

The following documentation is available for the Web Dashboard control:

• Create an ASP.NET Web Forms Dashboard Application
• ASP.NET Web Forms Dashboard Control
• Create Dashboards on the Web

Implements

IDashboardStateService

Inheritance

Object

Control

WebControl

ASPxWebControlBase

ASPxWebControl

ASPxWebClientUIControl

ASPxDashboard

MVCxDashboard