Skip to main content
All docs

DxReportViewer Class

A document viewer component for reports.

Namespace: DevExpress.Blazor.Reporting

Assembly: DevExpress.Blazor.Reporting.v23.1.Viewer.dll

NuGet Package: DevExpress.Blazor.Reporting.Viewer


public class DxReportViewer :


The DevExpress Report Viewer for Blazor (<DxReportViewer>) allows you to preview, print, and export reports.

DxReportViewer Overview

Add the Report Viewer to a Project

Follow the steps below to add the Report Viewer component to an application:

  1. Use a DevExpress Project Template to create a new Blazor Server application. If you use a Microsoft project template or already have a Blazor project, configure your project to incorporate DevExpress Blazor components.
  2. Add the NuGet package DevExpress.Blazor.Reporting.Viewer.
  3. Add the @using DevExpress.Blazor.Reporting directive to the_Imports.razor page.
  4. Add the following code to the ConfigureServices method in the Startup.cs file:

  5. Add the configuration to the UseEndpoints method. The method is called in the Configure method in the Startup.cs file:

    app.UseEndpoints(endpoints =>
      // ...
  6. Add the <DxReportViewer></DxReportViewer> markup to a Razor page.

  7. Link stylesheets to the page:

    <link rel="stylesheet" href="_content/DevExpress.Blazor.Reporting.Viewer/css/dx-blazor-reporting-components.css">
  8. Specify a report to open.
  9. Customize the toolbar and Parameters panel (refer to the sections below).

Specify a Report to Open

Use the Report property:

@using DevExpress.Blazor.Reporting
@using DevExpress.XtraReports;

<DxReportViewer @ref="reportViewer" Report="@Report">

@code {
    DxReportViewer reportViewer { get; set; }
    IReport Report { get; set; }

    protected override async Task OnInitializedAsync()
        Report = new TestReport();


A report may contain the XRSubreport control with the report source specified by name (a string). In this situation, you should implement and register the IReportProvider or IReportProviderAsync service that converts a report name to a report instance.

Customize the Toolbar

Handle the OnCustomizeToolbar event to add a new toolbar item or hide the existing item. The following code adds a new toolbar button:

@page "/toolbar/"

@using DevExpress.Blazor.Reporting
@using DevExpress.XtraReports.UI
@using BlazorCustomization.PredefinedReports
@using DevExpress.Blazor.Reporting.Models

@inject IJSRuntime JsRuntime

<div @ref="viewerComponent" style="width: 100%; height: 1000px;">
    <DxReportViewer @ref="reportViewer"
                    Report="Report" />

@code {
    DxReportViewer reportViewer;
    XtraReport Report = new TableReport();
    private ElementReference viewerComponent;

    void OnCustomizeToolbar(ToolbarModel toolbarModel)
        toolbarModel.AllItems.Add(new ToolbarItem()
            // Use Open Iconic's icon.
            IconCssClass = "oi oi-command",
            Text = "Full Screen",
            AdaptiveText = "Full Screen",
            AdaptivePriority = 1,
            Click = async (args) =>
                await JsRuntime.InvokeVoidAsync("customApi.requestFullscreen", viewerComponent);


The customized toolbar is shown in the image below.

DxReportViewer Custom Toolbar

View Example



See Also