DashboardJsonConverter Class

Provides methods that allow you to convert a dashboard XML definition to JSON and vice versa.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v24.1.Web.WebForms.dll

NuGet Package: DevExpress.Web.Dashboard

Declaration

C#

public static class DashboardJsonConverter

VB.NET

Public Module DashboardJsonConverter

Example

The code snippet below shows how to initialize the server-side Dashboard object from the JSON model obtained from the client side.

C#

using DevExpress.DashboardCommon;
using DevExpress.DashboardWeb;
// ...

        protected void ASPxDashboard1_CustomDataCallback(object sender, CustomDataCallbackEventArgs e) {
            System.Xml.Linq.XDocument dashboardDocument = DashboardJsonConverter.JsonToXml(e.Parameter);
            Dashboard dashboard = new Dashboard();
            dashboard.LoadFromXDocument(dashboardDocument);
        }

VB.NET

Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWeb
' ...

        Protected Sub ASPxDashboard1_CustomDataCallback(ByVal sender As Object, ByVal e As CustomDataCallbackEventArgs)
            Dim dashboardDocument As System.Xml.Linq.XDocument = DashboardJsonConverter.JsonToXml(e.Parameter)
            Dim dashboard As New Dashboard()
            dashboard.LoadFromXDocument(dashboardDocument)
        End Sub

JS

function onBeforeRender(sender, e) {
    var innerControl = sender.GetDashboardControl();
    // ...
    // The PerformDataCallback method is called within any function after a dashboard is loaded.
    sender.PerformDataCallback(JSON.stringify(innerControl.dashboard().getJSON()));
    // ...
}

ASPX

<dx:ASPxDashboard ID="ASPxDashboard1" runat="server" 
    ClientInstanceName="webDashboard"
    ClientSideEvents-BeforeRender="onBeforeRender"
    <!-- ... -->
</dx:ASPxDashboard> 

Inheritance

Object

DashboardJsonConverter