ASPxDashboard Class

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

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

Declaration

C#
VB.NET

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

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

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:

The following code snippets (auto-collected from DevExpress Examples) contain references to the ASPxDashboard 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-create-a-web-dashboard-designer-application-t362490/CS/Dashboard_WebDashboard_2010/Global.asax.cs#L8

protected void Application_Start(object sender, EventArgs e) {
    ASPxDashboard.HandleServerErrors = true;
}

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/CS/ShowDetailViewFromDashboard.Module.Web/Controllers/WebShowDetailViewFromDashboardController.cs#L31

}
private void CustomizeDashboardViewer(ASPxDashboard dashboardControl) {
    XafCallbackManager callbackManager = ((ICallbackManagerHolder)WebWindow.CurrentRequestPage).CallbackManager;

web-dashboard-show-popup-with-available-dashboards-and-load/CS/WebApp/Global.asax.cs#L13

protected void Application_Start(object sender, EventArgs e) {
    ASPxDashboard.StaticInitialize();
}

WebFormsDashboardConfigurator/CS/WebFormsDashboardConfigurator/Global.asax.cs#L12

protected void Application_Start(object sender, EventArgs e) {
    ASPxDashboard.StaticInitialize();
    DashboardConfigurator.Default.SetDashboardStorage(new DashboardFileStorage(Server.MapPath("App_Data/Dashboards")));

web-dashboard-how-to-store-json-connections-in-database/CS/DXWebApplication21/Global.asax.cs#L11


ASPxDashboard.StaticInitialize();

how-to-create-a-web-dashboard-designer-application-t362490/VB/Dashboard_WebDashboard_2010/Global.asax.vb#L9

Protected Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    ASPxDashboard.HandleServerErrors = True
End Sub

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/VB/ShowDetailViewFromDashboard.Module.Web/Controllers/WebShowDetailViewFromDashboardController.vb#L34

End Sub
Private Sub CustomizeDashboardViewer(ByVal dashboardControl As ASPxDashboard)
    Dim callbackManager As XafCallbackManager = DirectCast(WebWindow.CurrentRequestPage, ICallbackManagerHolder).CallbackManager

web-dashboard-show-popup-with-available-dashboards-and-load/VB/WebApp/Global.asax.vb#L14

Protected Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    ASPxDashboard.StaticInitialize()
End Sub

WebFormsDashboardConfigurator/VB/WebFormsDashboardConfigurator/Global.asax.vb#L14

Protected Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    ASPxDashboard.StaticInitialize()
    DashboardConfigurator.Default.SetDashboardStorage(New DashboardFileStorage(Server.MapPath("App_Data/Dashboards")))

web-dashboard-how-to-store-json-connections-in-database/VB/DXWebApplication21/Global.asax.vb#L13