ReportDesignerClientSideModelGenerator.GetJsonModelScript(String, IDictionary<String, Object>, String, String, String) Method

Generates a client-side Report Designer model based on specified data and serializes this model to Json.

Namespace: DevExpress.XtraReports.Web.ReportDesigner

Assembly: DevExpress.XtraReports.v23.2.Web.dll

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

public string GetJsonModelScript(
    string reportUrl,
    IDictionary<string, object> dataSources,
    string controllerUri,
    string previewControllerUri,
    string queryBuilderControllerUri
)

VB.NET

Public Function GetJsonModelScript(
    reportUrl As String,
    dataSources As IDictionary(Of String, Object),
    controllerUri As String,
    previewControllerUri As String,
    queryBuilderControllerUri As String
) As String

Parameters

Name	Type	Description
reportUrl	String	A URL of report that the Report Designer opens.
dataSources	IDictionary<String, Object>	A dictionary of data sources available in the Report Designer.
controllerUri	String	The URI of the controller action that processes Report Designer requests.
previewControllerUri	String	The URI of the controller action that processes Report Designer preview requests.
queryBuilderControllerUri	String	The URI of the controller action that processes Query Builder requests.

Returns

Type	Description
String	A string that contains a Report Designer model.

Remarks

This method internally calls the ReportStorageWebExtension.GetData method to obtain a report from a storage by the URL passed as a parameter.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetJsonModelScript(String, IDictionary<String, Object>, String, String, String) method.

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-web-mvc-localize-javascript-controls/CS/JSReportingLocalizationExample/Controllers/ReportDesignerController.cs#L33

string modelJsonScript =
    new ReportDesignerClientSideModelGenerator()
    .GetJsonModelScript(

reporting-basic-designer-javascript-integration/CS/DXWebApplication1/Controllers/ReportDesignerController.cs#L24

string modelJsonScript =
    new ReportDesignerClientSideModelGenerator()
    .GetJsonModelScript(

reporting-angular-integrate-report-designer/CS/ServerSide/Controllers/ReportDesignerController.cs#L25

string modelJsonScript =
    new ReportDesignerClientSideModelGenerator()
    .GetJsonModelScript(

reporting-angular-localize-controls/CS/AngularReportingLocalizationExample/Controllers/ReportDesignerController.cs#L33

string modelJsonScript =
    new ReportDesignerClientSideModelGenerator()
    .GetJsonModelScript(

reporting-vue-integrate-end-user-designer/CS/ServerSide/Controllers/ReportDesignerController.cs#L23

string modelJsonScript =
    new ReportDesignerClientSideModelGenerator()
    .GetJsonModelScript(

VB.NET

reporting-web-mvc-localize-javascript-controls/VB/JSReportingLocalizationExample/Controllers/ReportDesignerController.vb#L29

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. -  Available data sources in the Report Designer that can be added to reports. -  The URL of a report that is opened in the Report Designer when the application starts.
Return Content(modelJsonScript, "application/json")

reporting-basic-designer-javascript-integration/VB/DXWebApplication1/Controllers/ReportDesignerController.vb#L21

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. -  Available data sources in the Report Designer that can be added to reports. -  The URL of a report that is opened in the Report Designer when the application starts.
Return Content(modelJsonScript, "application/json")

reporting-angular-integrate-report-designer/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")

reporting-angular-localize-controls/VB/AngularReportingLocalizationExample/Controllers/ReportDesignerController.vb#L29

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. -  Available data sources in the Report Designer that can be added to reports. -  The URL of a report that is opened in the Report Designer when the application starts.
Return Content(modelJsonScript, "application/json")

reporting-vue-integrate-end-user-designer/VB/ServerSide/Controllers/ReportDesignerController.vb#L21

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. -  Available data sources in the Report Designer that can be added to reports. -  The URL of a report that is opened in the Report Designer when the application starts.
Return Content(modelJsonScript, "application/json")

Implements

GetJsonModelScript(String, IDictionary<String, Object>, String, String, String)