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.v18.1.Web.WebForms.dll

Declaration

C#

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

VB.NET

<ToolboxTabName("DX.18.1: Data & Analytics")>
<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 accept/return ASPxDashboard objects:

• WebDashboardViewerViewItem.DashboardControl
• WebDashboardViewerViewItem.DashboardDesigner

Remarks

The following documentation is available for the Web Dashboard control.

• Getting Started - Create an ASP.NET Designer

  Shows how to create the Dashboard Designer application using the ASP.NET Dashboard control.

• Getting Started - Create an ASP.NET MVC Designer

  Guides you through the steps on how to create the Dashboard Designer application using the ASP.NET MVC Dashboard extension.

• Getting Started - Create an HTML5 JavaScript Designer

  Shows how to use the HTML5 JavaScript Dashboard control to create the Dashboard Designer application.

• Building the Designer and Viewer Applications - Web Dashboard

  Describes how to prepare and customize the Web Dashboard control.

• Creating Dashboards on the Web

  Contains guides that will show you how to design dashboards using the Web Dashboard.

Related GitHub Examples

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#

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();
}

VB.NET

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

Implements

IDashboardStateService

Inheritance

Object

Control

WebControl

ASPxWebControlBase

ASPxWebControl

ASPxWebClientUIControl

ASPxDashboard

ASPxDashboardDesigner

MVCxDashboard