DevExpress.AspNetCore.Reporting 26.1.5-pre-26235

DevExpress Web Reporting Components for ASP.NET Core

This package contains the server-side services and MVC controller base classes that handle DevExpress Web Reporting requests in ASP.NET Core applications for the Document Viewer, End-User Report Designer, Query Builder, and Standalone Report Parameters Panel.

The UI controls ship separately as npm packages, so the front end can be an MVC or Razor Pages view, or an Angular, React, or Vue app. The packages you install depend on the client framework you use.

Supported Components

• Document Viewer: Displays an interactive document preview generated from a DevExpress Report. The Document Viewer allows users to preview data, change report parameters, print, and export the resulting document.
• End-User Report Designer: Allows users to create and modify reports using a drag-and-drop interface. Supports various data source types. Includes a fully functional Document Viewer to preview and export reports.
• Query Builder: A graphical tool that allows you to interactively build queries based on tables and views in an SQL Data Source, preview SQL statements, and view the results.
• Standalone Report Parameters Panel: A panel with report parameter editors. Use this component to submit report parameter values, programmatically create a report based on the specified values, and then export or email it without displaying a preview to users.

Example: Add a Document Viewer and End-User Report Designer to an ASP.NET Core MVC App

1. Install this package and the client-side libraries. Refer to the following section for the complete list: Manage Packages and Libraries.

2. Add a report to the project and implement a report name resolution service that translates a report name to a report instance:

   using DevExpress.XtraReports.Services;
   using DevExpress.XtraReports.UI;
   
   // Maps a report name to a report instance.
   public static class ReportsFactory {
       public static Dictionary<string, Func<XtraReport>> Reports = new() {
           ["TestReport"] = () => new TestReport()
       };
   }
   
   public class CustomReportProvider : IReportProvider {
       public XtraReport GetReport(string id, ReportProviderContext context) {
           if (ReportsFactory.Reports.TryGetValue(id, out var report))
               return report();
           throw new DevExpress.XtraReports.Web.ClientControls.FaultException($"Could not find report '{id}'.");
       }
   }
   

3. Configure services in Program.cs:

   using DevExpress.AspNetCore;
   using DevExpress.AspNetCore.Reporting;
   using DevExpress.XtraReports.Services;
   
   var builder = WebApplication.CreateBuilder(args);
   builder.Services.AddControllersWithViews();
   
   // Add DevExpress Reporting services.
   builder.Services.AddDevExpressControls();
   builder.Services.ConfigureReportingServices(configurator => {
       configurator.ConfigureWebDocumentViewer(viewerConfigurator => {
           // Cache generated documents between requests: reduces memory use and
           // supports web farms and app restarts.
           viewerConfigurator.UseCachedReportSourceBuilder();
       });
   });
   // Resolve reports by name. Register after AddDevExpressControls.
   builder.Services.AddScoped<IReportProvider, CustomReportProvider>();
   
   var app = builder.Build();
   app.UseDevExpressControls();
   // ...
   app.Run();
   

4. Implement a controller for each component. The Document Viewer requires a Document Viewer controller; the End-User Report Designer requires all three:

   using DevExpress.AspNetCore.Reporting.QueryBuilder;
   using DevExpress.AspNetCore.Reporting.QueryBuilder.Native.Services;
   using DevExpress.AspNetCore.Reporting.ReportDesigner;
   using DevExpress.AspNetCore.Reporting.ReportDesigner.Native.Services;
   using DevExpress.AspNetCore.Reporting.WebDocumentViewer;
   using DevExpress.AspNetCore.Reporting.WebDocumentViewer.Native.Services;
   
   public class CustomWebDocumentViewerController : WebDocumentViewerController {
       public CustomWebDocumentViewerController(IWebDocumentViewerMvcControllerService controllerService)
           : base(controllerService) { }
   }
   
   public class CustomReportDesignerController : ReportDesignerController {
       public CustomReportDesignerController(IReportDesignerMvcControllerService controllerService)
           : base(controllerService) { }
   }
   
   public class CustomQueryBuilderController : QueryBuilderController {
       public CustomQueryBuilderController(IQueryBuilderMvcControllerService controllerService)
           : base(controllerService) { }
   }
   

5. Reference the DevExpress.AspNetCore namespace in _ViewImports.cshtml:

   @* _ViewImports.cshtml *@
   @using DevExpress.AspNetCore
   

6. In the _Layout.cshtml head section, attach the shared third-party bundle. Step 1 builds this bundle, along with the per-component bundles used below, from the installed client-side libraries through bundleconfig.json:

   @* _Layout.cshtml *@
   <link rel="stylesheet" href="~/css/thirdparty.bundle.css" />
   <script src="~/js/thirdparty.bundle.js"></script>
   

7. Add a component to a view together with its client-side bundle. Bind the Document Viewer and Report Designer by report name (resolved by the service implemented in step 2):

   @* Document Viewer *@
   <link rel="stylesheet" href="~/css/viewer.part.bundle.css" />
   <script src="~/js/viewer.part.bundle.js"></script>
   
   @Html.DevExpress().WebDocumentViewer("DocumentViewer").Height("1000px").Bind("TestReport")
   

   @* End-User Report Designer *@
   <link rel="stylesheet" href="~/css/designer.part.bundle.css" />
   <script src="~/js/designer.part.bundle.js"></script>
   
   @(Html.DevExpress().ReportDesigner("reportDesigner").Height("1000px").Bind("TestReport"))
   

The End-User Report Designer also requires a report storage so users can open and save report definitions. Refer to the following help topic for the full CustomReportStorageWebExtension implementation: Add a Report Storage.

For complete walkthroughs, refer to the following get-started tutorials:

• Document Viewer
• End-User Report Designer
• Standalone Report Parameters Panel.

Evaluation Period, Pricing Options, and Licensing Terms

Whether you own a license or want to start a 30-day evaluation, download and register your DevExpress license key. To obtain your key, sign in to the DevExpress Download Manager with an existing DevExpress.com account or create a free account. For key registration instructions, see License Key for DevExpress Products.

If you purchase a license after evaluating a product, re-register your updated DevExpress license key to remove evaluation warnings and messages.

This package is included in the following commercial subscriptions:

• DevExpress Reporting Subscription
• DevExpress ASP.NET Subscription
• DevExpress DXperience Subscription
• DevExpress Universal Subscription

See DevExpress Subscriptions & Licensing for subscription comparison tables, purchasing FAQ, and licensing information.

Related Components/Packages

DevExpress.AspNetCore.Reporting.Azure — Microsoft Azure integration. Cache generated report documents in Azure Storage for scalable, stateless deployments on Microsoft Azure.

dotnet add package DevExpress.AspNetCore.Reporting.Azure

DevExpress.AIIntegration.AspNetCore.Reporting — AI-powered Summarize, Translate, Prompt-to-Report, Prompt-to-Expression, Localization, and Test Data extensions for the Document Viewer and Report Designer.

dotnet add package DevExpress.AIIntegration.AspNetCore.Reporting

Demos

• ASP.NET Core Reporting Demos
• DevExpress Reports Demos on GitHub

Documentation

• Reporting for ASP.NET Core
• Reporting for Angular
• Reporting for React
• Reporting for Vue

Software Bill of Materials (SBOM)

To access SBOM files for DevExpress packages, please refer to the following article: Software Bill of Materials (SBOM) for DevExpress .NET assemblies/NuGet packages, JavaScript, VCL and other redistributable artifacts.

See Also: Information Security | Security - What You Need to Know

Useful Online Resources

• www.devexpress.com
• DevExpress Support Center
• DevExpress Blogs