Search results

Add Web Report Designer to an ASP.NET Core Razor Pages

This section explains the steps required to add Web Report Designer to an ASP.NET Core Razor Pages application. To create an ASP.NET Core Razor Pages application with Bold Report Designer version higher than v8.1.xx, follow these steps:

Bold Reports^® ASP.NET Core supports from .NET Core 8.0 only. So, choose the .NET Core version ASP.NET Core 8.0 or higher versions for Designer API creation. The source code for this ASP.NET Core Razor Pages application is available on GitHub.

Prerequisites

Before getting started with bold web report designer, make sure your development environment includes the following requirements.

Visual Studio 2022 with ASP.NET and Web Development workloads.
.NET Core 8.0 Framework.

Create ASP.NET Core application

Start Visual Studio 2022 and click Create new project.
Choose ASP.NET Core Web App, and then click Next.
Change the project name, and then click Create.
In the dropdown for the Framework, choose .NET 8.0 or .NET 9.0, then click Create.

List of dependency libraries

In the Solution Explorer tab, right-click the project or solution, and choose Manage NuGet Packages. Alternatively, select the Tools > NuGet Package Manager > Manage NuGet Packages for Solution menu command.
Search for BoldReports.Net.Core, BoldReports.AspNet.Core packages, and install them in your Core application. The following table provides details about the packages and their usage.

Package	Purpose
`BoldReports.Net.Core`	Used to create Web API service for processing the reports.
`BoldReports.AspNet.Core`	Contains tag helpers to create client-side web Report Designer control.

Refer to the NuGet Packages to learn more details about installing and configuring Report Designer NuGet packages.

The following table provides details about the dependency packages and its usage.

Assemblies	Purpose
`Syncfusion.Compression.Net.Core`	Exports the report to a PDF, Microsoft Word, and Microsoft Excel format. It is a base library for the Syncfusion.Pdf.Net.Core, Syncfusion.DocIO.Net.Core, and Syncfusion.XlsIO.Net.Core packages.
`Syncfusion.Pdf.Net.Core`	Supports for exporting the report to a PDF.
`Syncfusion.DocIO.Net.Core`	Supports for exporting the report to a Word.
`Syncfusion.XlsIO.Net.Core`	Supports for exporting the report to an Excel.
`Syncfusion.OfficeChart.Net.Core`	It is a base library of the Syncfusion.XlsIO.Net.Core package.
`Newtonsoft.Json`	Serialize and deserialize the data or report for report designer. It is a mandatory package for the report designer, and the package version should be 13.0.3 or higher for .NET 8.0 Core or higher framework.
`Microsoft.Data.SqlClient`	This is an optional package. If the RDL report contains the SQL Server or SQL Azure data source, then this package should be installed. Also, the package version should be higher of 5.1.0.

Refer Scripts and CSS

Directly refer the scripts and style sheets that are mandatorily required to render the web Report Designer, from CDN links.

Open the ~/Pages/Shared/_Layout.cshtml page and refer the scripts and styles as shown in the below example code.

Replace the following code in your ~/Pages/Shared/_Layout.cshtml page <head> tag.

<link href="https://cdn.boldreports.com/9.1.7/content/v2.0/tailwind-light/bold.report-designer.min.css" rel="stylesheet" />
<link href="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/codemirror.min.css" rel="stylesheet" />
<link href="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/addon/hint/show-hint.min.css" rel="stylesheet" />

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>

<script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/codemirror.min.js" type="text/javascript"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/addon/hint/show-hint.min.js" type="text/javascript"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/addon/hint/sql-hint.min.js" type="text/javascript"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/mode/sql/sql.min.js" type="text/javascript"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/mode/vb/vb.min.js" type="text/javascript"></script>

<!-- Report Designer component dependent scripts -->
<script src="https://cdn.boldreports.com/9.1.7/scripts/v2.0/common/bold.reports.common.min.js"></script>
<script src="https://cdn.boldreports.com/9.1.7/scripts/v2.0/common/bold.reports.widgets.min.js"></script>

<!-- Report Viewer and Designer component scripts -->
<script src="https://cdn.boldreports.com/9.1.7/scripts/v2.0/bold.report-viewer.min.js"></script>
<script src="https://cdn.boldreports.com/9.1.7/scripts/v2.0/bold.report-designer.min.js"></script>

Refer to the Dependencies to learn more details about web Report Designer dependent scripts and style sheets links.

Tag helper

It is necessary to define the following tag helper within the _ViewImports.cshtml page to initialize the web Report Designer component with the tag helper support.

    @using BoldReports.TagHelpers
    @addTagHelper *, BoldReports.AspNet.Core

Configure Script Manager

Open the ~/Pages/Shared/_Layout.cshtml page and add the reporting Script Manager at the end of <body> element as in the following code sample.

<body>
    <div>
        @RenderBody()
    </div>

    @RenderSection("Scripts", required: false)
    <!-- Bold Reports<sup>®</sup> script manager -->
   <bold-script-manager></bold-script-manager>
</body>

Initialize Report Designer

Open the Index.cshtml page.

Remove the existing codes and add the following code.

@page
<div style="min-height: 950px;width: 100%;">
    <bold-report-designer id="designer"></bold-report-designer>
</div>

Add API Controller

Right-click the project and select Add > New Item from the context menu.
In the Add New Item dialog, select API Controller class and name it as ReportingAPIController, and then click Add.

While adding API Controller class, name it with the suffix Controller that is mandatory.

Configure Web API

The IReportDesignerController interface contains the required actions and helper methods declaration to process the designer file and data actions. The ReportDesignerHelper and ReportHelper class contains methods that help to process Post or Get request from the control and return the response.

ReportDesignerHelper

The class ReportDesignerHelper contains helper methods that help to process Post or Get request from the web Report Designer control and returns the response to the web Report Designer control. It has the following methods.

Methods	Description
GetResource	Returns the report resource for the requested key.
ProcessReport	Processes the report request and returns the result.

ReportHelper

The class ReportHelper contains helper methods that help process Post or Get request for report preview action and returns the response to the web Report Designer. It has the following methods.

Methods	Description
GetResource	Returns the report resource for the requested key.
ProcessReport	Processes the report request and returns the result.

Open ReportingAPIController.cs file and add the following using statement.

    using Microsoft.AspNetCore.Mvc;
    using System.IO;
    using BoldReports.Web.ReportDesigner;
    using BoldReports.Web.ReportViewer;

Inherit the IReportDesignerController interface, and then implement its methods.

It is required for processing the designer file and data actions from the Report Designer.

Create local variables inside the ReportingAPIController class.

    private Microsoft.Extensions.Caching.Memory.IMemoryCache _cache;
    private Microsoft.AspNetCore.Hosting.IWebHostEnvironment _hostingEnvironment;

Set the Route attribute for ReportingAPIController.

    [Route("api/[controller]/[action]")]
    public class ReportingAPIController : Controller, IReportDesignerController
    {
        ...
    }

You can replace the following code in the ReportingAPIController class.

    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Threading.Tasks;
    using Microsoft.AspNetCore.Http;
    using Microsoft.AspNetCore.Mvc;
    using BoldReports.Web.ReportViewer;
    using BoldReports.Web.ReportDesigner;

    namespace ReportDesignerSample
    {
        [Route("api/[controller]/[action]")]
        public class ReportingAPIController : Controller, IReportDesignerController
        {
            private Microsoft.Extensions.Caching.Memory.IMemoryCache _cache;
            private Microsoft.AspNetCore.Hosting.IWebHostEnvironment _hostingEnvironment;

            public ReportingAPIController(Microsoft.Extensions.Caching.Memory.IMemoryCache memoryCache, Microsoft.AspNetCore.Hosting.IWebHostEnvironment hostingEnvironment)
            {
                _cache = memoryCache;
                _hostingEnvironment = hostingEnvironment;
            }

            [NonAction]
            private string GetFilePath(string itemName, string key)
            {
                string dirPath = Path.Combine(this._hostingEnvironment.WebRootPath, "Cache", key);

                if (!System.IO.Directory.Exists(dirPath))
                {
                    System.IO.Directory.CreateDirectory(dirPath);
                }

                return Path.Combine(dirPath, itemName);
            }

            public object GetImage(string key, string image)
            {
                return ReportDesignerHelper.GetImage(key, image, this);
            }

            public object GetResource(ReportResource resource)
            {
                return ReportHelper.GetResource(resource, this, _cache);
            }

            [NonAction]
            public void OnInitReportOptions(ReportViewerOptions reportOption)
            {
                //You can update report options here
            }

            [NonAction]
            public void OnReportLoaded(ReportViewerOptions reportOption)
            {
                //You can update report options here
            }

            [HttpPost]
            public object PostDesignerAction([FromBody] Dictionary<string, object> jsonResult)
            {
                return ReportDesignerHelper.ProcessDesigner(jsonResult, this, null, this._cache);
            }

            public object PostFormDesignerAction()
            {
                return ReportDesignerHelper.ProcessDesigner(null, this, null, this._cache);
            }

            public object PostFormReportAction()
            {
                return ReportHelper.ProcessReport(null, this, this._cache);
            }

            [HttpPost]
            public object PostReportAction([FromBody] Dictionary<string, object> jsonResult)
            {
                return ReportHelper.ProcessReport(jsonResult, this, this._cache);
            }

            [NonAction]
            public bool SetData(string key, string itemId, ItemInfo itemData, out string errorMessage)
            {
                errorMessage = string.Empty;
                if (itemData.Data != null) {
                    System.IO.File.WriteAllBytes(this.GetFilePath(itemId, key), itemData.Data);
                }
                else if (itemData.PostedFile != null) {
                    var fileName = itemId;
                    if (string.IsNullOrEmpty(itemId)) {
                        fileName = System.IO.Path.GetFileName(itemData.PostedFile.FileName);
                    }

                    using(System.IO.MemoryStream stream = new System.IO.MemoryStream())
                    {
                        itemData.PostedFile.OpenReadStream().CopyTo(stream);
                        byte[] bytes = stream.ToArray();
                        var writePath = this.GetFilePath(fileName, key);

                        System.IO.File.WriteAllBytes(writePath, bytes);
                        stream.Close();
                        stream.Dispose();
                    }
                }
                return true;
            }
            [NonAction]
            public ResourceInfo GetData(string key, string itemId)
            {
                var resource = new ResourceInfo();
                try
                {
                    var filePath = this.GetFilePath(itemId, key);
                    if (itemId.Equals(Path.GetFileName(filePath), StringComparison.InvariantCultureIgnoreCase) && System.IO.File.Exists(filePath))
                    {
                        resource.Data = System.IO.File.ReadAllBytes(filePath);
                    }
                    else
                    {
                        resource.ErrorMessage = "File not found from the specified path";
                    }
                }
                catch (Exception ex)
                {
                    resource.ErrorMessage = ex.Message;
                }
                return resource;
            }

            [HttpPost]
            public void UploadReportAction()
            {
                ReportDesignerHelper.ProcessDesigner(null, this, this.Request.Form.Files[0], this._cache);
            }
        }
    }

Web API with ASP.NET Core Web Application

Default ASP.NET Core Razor Pages template (Web Application) does not have MapControllers configuration to use Web API. So, need to add MapControllers options with App using the below steps,

Open Program.cs file.

Call MapControllers with app in next of app.UseRouting() as in below code.

  ....
  ....
  app.UseRouting();
  app.MapControllers();
  ....
  ....

Finally, your Program.cs file looks like below,

    var builder = WebApplication.CreateBuilder(args);

    // Add services to the container.
    builder.Services.AddRazorPages();
    var app = builder.Build();

    // Configure the HTTP request pipeline.
    if (!app.Environment.IsDevelopment())
    {
        app.UseExceptionHandler("/Error");
        app.UseHsts();
    }

    app.UseHttpsRedirection();
    app.UseStaticFiles();

    app.UseRouting();
    app.MapControllers();

    app.UseAuthorization();
    app.MapRazorPages();
    app.Run();

Set the service URL

To browse, open, and save reports in the Web Report Designer, set the ServiceUrl to your WebAPI controller name.

Open the Index.cshtml page.
Set the WebAPI controller name to the ServiceUrl property as shown in below code snippet.

    @page
    <div style="min-height: 950px;width: 100%;">
        <bold-report-designer id="designer" service-url="/api/ReportingAPI" ></bold-report-designer>
    </div>

Run the Application

Run the sample application and you can see the web ReportDesigner on the page as displayed in the following screenshot.

Report Designer demo

CONTENTS

Prerequisites
Create ASPNET Core application
List of dependency libraries
Refer Scripts and CSS
Tag helper
Configure Script Manager
Initialize Report Designer
Add API Controller
Configure Web API
ReportDesignerHelper
ReportHelper
Web API with ASPNET Core Web Application
Set the service URL
Run the Application

Having trouble getting help?
Contact Support

CONTENTS

Prerequisites
Create ASPNET Core application
List of dependency libraries
Refer Scripts and CSS
Tag helper
Configure Script Manager
Initialize Report Designer
Add API Controller
Configure Web API
ReportDesignerHelper
ReportHelper
Web API with ASPNET Core Web Application
Set the service URL
Run the Application

Having trouble getting help?
Contact Support

Please provide additional information

Thank you for your feedback and comments.We will rectify this as soon as possible!