ReportDesignerClientSideModelGenerator Class

The class used to generate a client-side model of the Web End-User Report Designer.

Namespace: DevExpress.XtraReports.Web.ReportDesigner

Assembly: DevExpress.XtraReports.v19.1.Web.dll

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public class ReportDesignerClientSideModelGenerator

VB.NET

Public Class ReportDesignerClientSideModelGenerator

Example

The following code implements the controller action specified in the JavaScript-based application’s client-side configuration and returns the Report Designer model.

Note

The complete sample project How to Perform the JavaScript Report Designer Integration (with npm or Yarn package managers) is available in the DevExpress Examples repository.

ReportDesignerController.cs

using DevExpress.Web.Mvc.Controllers;
using DevExpress.XtraReports.Web.ReportDesigner;
using System.Web.Mvc;
// ...
  public ActionResult GetReportDesignerModel(string reportUrl)
  {
      Response.AppendHeader("Access-Control-Allow-Origin", "*");

      string modelJsonScript =
          new ReportDesignerClientSideModelGenerator()
          .GetJsonModelScript(
              reportUrl,
              // A report that the Report Designer loads when the application starts.
              GetAvailableDataSources(),
              // Data sources available in the Report Designer.
              "ReportDesigner/Invoke",
              // Controller action that processes Report Designer requests.
              "WebDocumentViewer/Invoke",
              // Controller action that processes Web Document Viewer requests.
              "QueryBuilder/Invoke"      
              // Controller action that processes Query Builder requests.
          );
      return Content(modelJsonScript, "application/json");
  }

ReportDesignerController.vb

Imports DevExpress.Web.Mvc.Controllers
Imports DevExpress.XtraReports.Web.ReportDesigner
Imports System.Web.Mvc
' ...
  Public Function GetReportDesignerModel(ByVal reportUrl As String) As ActionResult
      Response.AppendHeader("Access-Control-Allow-Origin", "*")

      Dim modelJsonScript As String = (New ReportDesignerClientSideModelGenerator()).GetJsonModelScript(reportUrl, GetAvailableDataSources(), "ReportDesigner/Invoke", "WebDocumentViewer/Invoke", "QueryBuilder/Invoke") 
      Return Content(modelJsonScript, "application/json")
  End Function

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ReportDesignerClientSideModelGenerator 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#

Reporting_how-to-use-the-web-report-designer-in-javascript-with-reactjs-t561295/CS/ServerSide/Controllers/ReportDesignerController.cs#L25

string modelJsonScript =
    new ReportDesignerClientSideModelGenerator()
    .GetJsonModelScript(

VB.NET

Reporting_how-to-use-the-web-report-designer-in-javascript-with-reactjs-t561295/VB/ServerSide/Controllers/ReportDesignerController.vb#L26

Dim modelJsonScript As String = (New ReportDesignerClientSideModelGenerator()).GetJsonModelScript(reportUrl, GetAvailableDataSources(), "ReportDesigner/Invoke", "WebDocumentViewer/Invoke", "QueryBuilder/Invoke") ' The URI path of the controller action that processes requests from the Query Builder. -  The URI path of the controller action that processes requests from the Web Document Viewer. -  The URI path of the controller action that processes requests from the Report Designer. -  Obtain data sources that will be available in the Report Designer for adding to reports. -  Obtain a report to open in the Report Designer on application start.
Return Content(modelJsonScript, "application/json")

Inheritance

Object

ReportDesignerClientSideModelGenerator