Search results

Export report

The Report Viewer provides events and properties to control and customize the report exporting functionality.

Export event handling

You can show the progress information, when the exporting process takes long time to complete using the export-progress-changed event.

  1. Set the export-progress-changed event in Report Viewer initialization.
  2. Implement the function and replace the following code samples to show a custom message based on the progress stage.

The following code example demonstrates how to export event handling in the Report Viewer at client side.

    <bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" export-progress-changed="onExportProgressChanged">
    </bold-report-viewer>
    <script type="text/javascript">
        function onExportProgressChanged(args) {
            if (args.stage === "beginExport") {
                console.log(args.stage);
                args.format =
                    $('#viewer').ejWaitingPopup({ showOnInit: true, cssClass: "customStyle", text: "Preparing exporting document.. Please wait..." });
            }
            else if (args.stage === "exportStarted") {
                console.log(args.stage);
                var popupObj1 = $('#viewer').data('ejWaitingPopup');
                popupObj1.hide();
            }
            else if (args.stage === "preparation") {
                console.log(args.stage);
                console.log(args.format);
                console.log(args.preparationStage);
                if (args.format === "PDF" && args.preparationStage === "documentPreparation") {
                    console.log(args.totalPages);
                    console.log(args.currentPage);
                    if (args.totalPages > 1 && args.currentPage > 1) {
                        var progressPercentage = Math.floor((args.currentPage / args.totalPages) * 100);
                        if (progressPercentage > 0) {
                            var popupObj2 = $('#viewer').data('ejWaitingPopup');
                            popupObj2.setModel({ text: "Preparing exporting document.." + progressPercentage + " % completed.. Please wait..." });
                        }
                    }
                }
            }

            args.handled = true;
        }
    </script>

Change Excel and Word export format

Allows you change the default file format to any other file format using the ExcelFormat and WordFormat properties.

The following code example demonstrates how to change Excel and Word export format in the Report Viewer at client side.

    <bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" export-settings="ViewBag.exportSettings">
    </bold-report-viewer>

The following code example demonstrates how to change Excel and Word export format in the Report Viewer at server side.

    public ActionResult Index()
    {
        ViewBag.exportSettings = new BoldReports.Models.ReportViewer.ExportSettings();
        ViewBag.exportSettings.ExcelFormat = BoldReports.ReportViewerEnums.ExcelFormats.Excel2013;
        ViewBag.exportSettings.WordFormat = BoldReports.ReportViewerEnums.WordFormats.Word2013;
        return View();
    }

Export data visualization items

To export the reports with data visualization components, it is mandatory to configure the web scripts in Report Viewer Web API controller. If the report definition uses chart, gauge and map report items then configure the scripts in Web API as the following steps,

  1. Open the Report Viewer Web API controller.

  2. Configure the below scripts and styles in OnInitReportOptions on Web API controller.

    • jquery-1.10.2.min.js
    • bold.reports.common.min.js
    • bold.reports.widgets.min.js
    • ej.chart.min.js
    • ej.lineargauge.min.js
    • ej.circulargauge.min.js
    • ej.map.min.js
    • bold.report-viewer.min.js
  3. You can replace the following codes in Report Viewer Web API controller.

    public void OnInitReportOptions(ReportViewerOptions reportOption)
    {
        reportOption.ReportModel.ExportResourceOption.Scripts = new List<string>
        {
            "https://cdn.syncfusion.com/2.1.23/bold-reports/common/bold.reports.widgets.min.js",
            "https://cdn.syncfusion.com/2.1.23/bold-reports/common/bold.reports.common.min.js",
            //Chart component script
            "https://cdn.syncfusion.com/2.1.23/bold-reports/data-visualization/ej.chart.min.js",
            //Gauge component scripts
            "https://cdn.syncfusion.com/2.1.23/bold-reports/data-visualization/ej.lineargauge.min.js",
            "https://cdn.syncfusion.com/2.1.23/bold-reports/data-visualization/ej.circulargauge.min.js",
            //Map component script
            "https://cdn.syncfusion.com/2.1.23/bold-reports/data-visualization/ej.map.min.js",
            //Report Viewer Script
            "https://cdn.syncfusion.com/2.1.23/bold-reports/bold.report-viewer.min.js",
        };
    
        reportOption.ReportModel.ExportResourceOption.DependentScripts = new List<string>
        {
            "https://code.jquery.com/jquery-1.10.2.min.js"
        };
    }

    The data visulization components will not export without the above script configurations.

Export data visualization items in core environment

Report Viewer uses WebBrowser to export the data visualization items to PDF, Word, Excel file formats. The WebBrowser is not supported in Core environment. To overcome this limitation in Core environment, we have provided an option to export the data visualization report items using PhantomJS.

It supported ASP.NET Core 2.1 or above ASP.NET Core 2.1 version only. To download PhantomJS application and deploy it on your machine, you should accept it’s license terms on LICENSE and Third-Party document.

  1. Download PhantomJS from here and extract the download file.
  2. Copy the PhantomJS.exe file from the extracted bin folder and paste into wwwroot/PhantomJS folder in your application.
  3. Open the Report Viewer Web API controller.
  4. Set the UsePhantomJS property to true and PhantomJSPath property in OnInitReportOptions method.
    // Method will be called to initialize the report information to load the report with ReportHelper for processing.
    public void OnInitReportOptions(ReportViewerOptions reportOption)
    {
        string basePath = _hostingEnvironment.WebRootPath;
        reportOption.ReportModel.ExportResources.UsePhantomJS = true;
        reportOption.ReportModel.ExportResources.PhantomJSPath = basePath + @"\PhantomJS\";

        reportOption.ReportModel.ExportResourceOption.Scripts = new List<string>
        {
            "https://cdn.syncfusion.com/2.1.23/bold-reports/common/bold.reports.widgets.min.js",
            "https://cdn.syncfusion.com/2.1.23/bold-reports/common/bold.reports.common.min.js",
            //Chart component script
            "https://cdn.syncfusion.com/2.1.23/bold-reports/data-visualization/ej.chart.min.js",
            //Gauge component scripts
            "https://cdn.syncfusion.com/2.1.23/bold-reports/data-visualization/ej.lineargauge.min.js",
            "https://cdn.syncfusion.com/2.1.23/bold-reports/data-visualization/ej.circulargauge.min.js",
            //Map component script
            "https://cdn.syncfusion.com/2.1.23/bold-reports/data-visualization/ej.map.min.js",
            //Report Viewer Script
            "https://cdn.syncfusion.com/2.1.23/bold-reports/bold.report-viewer.min.js",
        };

        reportOption.ReportModel.ExportResourceOption.DependentScripts = new List<string>
        {
            "https://code.jquery.com/jquery-1.10.2.min.js"
        };
    }

The Scripts and Dependent scripts must be added to export the items. For more details refer to the export data visualization items section.

Hide specific export type for report

Show or hide the default export types available in the component using the ExportOptions property.

The following code example demonstrates how to hide specific export type to the report in the Report Viewer at client side.

    <bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" export-settings="ViewBag.exportSettings">
    </bold-report-viewer>

The following code example demonstrates how to hide specific export type to the report in the Report Viewer at server side.

    public ActionResult Index()
    {
        ViewBag.exportSettings = new BoldReports.Models.ReportViewer.ExportSettings();
        ViewBag.exportSettings.ExportOptions = BoldReports.ReportViewerEnums.ExportOptions.All
                                            & ~BoldReports.ReportViewerEnums.ExportOptions.Pdf;
        return View();
    }

PDF export options

The PDFOptions provides properties to manage PDF export behaviors. You should set the properties in the OnInitReportOptions method of the Web API service.

Export with complex scripts

To export reports with the complex scripts, set the ComplexScript property of PDFOptions instance to true.

    public void OnInitReportOptions(ReportViewerOptions reportOption)
    {
        reportOption.ReportModel.PDFOptions = new BoldReports.Writer.PDFOptions()
        {
            EnableComplexScript = true
        };
    }

PDF conformance

You can export the report as a PDF/A-1b document by specifying the PdfConformanceLevel.Pdf_A1B conformance level in the PdfConformanceLevel property.

    public void OnInitReportOptions(ReportViewerOptions reportOption)
    {
        reportOption.ReportModel.PDFOptions = new BoldReports.Writer.PDFOptions()
        {
            PdfConformanceLevel = Syncfusion.Pdf.PdfConformanceLevel.Pdf_A1B
        };
    }

Add custom PDF fonts

You can add custom fonts to the PDF exported document by adding the font streams to Fonts collection in PDFOptions instance.

To add custom fonts to the PDF exported document, follow these steps:

  1. Add the font .ttf files into your application wwwroot/Resources folder.
  2. In the Solution Explorer, open the properties of the font file and set the Copy property to Output Directory as Copy always.
  3. Initialize the Font collection and add the font stream to it.

The key value provided in the font collection should be same as in the report item font property.

    public void OnInitReportOptions(ReportViewerOptions reportOption)
    {
        string basePath = _hostingEnvironment.WebRootPath;
        reportOption.ReportModel.PDFOptions = new BoldReports.Writer.PDFOptions()
        {
            //Load Missing font stream
            Fonts = new Dictionary<string, System.IO.Stream>
            {
                { "Segoe UI", new FileStream(basePath + @"\Resources\font_symbols.ttf", FileMode.Open, FileAccess.Read) }
            }
        };
    }

If any fonts used in the report definition is not installed or available in the local system, then you should load the font stream. In the above code, font_symbols font stream is loaded to export the sales-order-detail.rdl report as symbols.

Word export options

The WordOptions provides properties to manage Word document export behaviors.

Word document type

You can save the report to the required document version by setting the FormatType property.

    reportOption.ReportModel.WordOptions = new BoldReports.Writer.WordOptions()
    {
        FormatType = BoldReports.Writer.WordFormatType.Docx
    };

Word document advance layout for merged cells

Eliminate the tiny columns, rows, merged cells, and render the word document elements without nested grid layout by setting the LayoutOption to TopLevel. The ParagraphSpacing is the distance value added between two elements in the document.

    reportOption.ReportModel.WordOptions = new BoldReports.Writer.WordOptions()
    {
        LayoutOption = BoldReports.Writer.WordLayoutOptions.TopLevel,
        ParagraphSpacing = new BoldReports.Writer.ParagraphSpacing()
        {
            Bottom = 0.5f,
            Top = 0.5f
        }
    };

A paragraph element is inserted between two tables in the exported document to overcome word document auto merging behavior. The table in the word document is not a stand-alone object. If you draw two tables one after another, it will automatically get merged into a single table. To prevent this merging, add an empty paragraph between two tables.

Protecting Word document from editing

You can restrict a Word document from editing either by providing a password or without password. The following are the types of protection:

  • AllowOnlyComments: Adds or modifies only the comments in the Word document.
  • AllowOnlyFormFields: Modifies the form field values in the Word document.
  • AllowOnlyRevisions: Accepts or rejects the revisions in the Word document.
  • AllowOnlyReading: Views the content only in the Word document.
  • NoProtection: Accesses or edits the Word document contents as normally.
    reportOption.ReportModel.WordOptions = new BoldReports.Writer.WordOptions()
    {
        ProtectionType = Syncfusion.DocIO.ProtectionType.AllowOnlyReading
    };

Excel export options

The ExcelOptions provides properties to manage Excel document export behaviors.

Excel document type

You can save the report to the required excel version by setting the ExcelSaveType property.

    reportOption.ReportModel.ExcelOptions = new BoldReports.Writer.ExcelOptions()
    {
        ExcelSaveType = BoldReports.Writer.ExcelVersion.Excel2013
    };

Excel document advance layout for merged cells

Eliminate the tiny columns, rows, and merged cells to provide clear readability and perform data manipulations by setting the LayoutOption to IgnoreCellMerge.

    reportOption.ReportModel.ExcelOptions = new BoldReports.Writer.ExcelOptions()
    {
        LayoutOption = BoldReports.Writer.ExcelLayoutOptions.IgnoreCellMerge
    };

Protecting Excel document from editing

You can restrict the Excel document from editing either by providing the ExcelSheetProtection or enabling the ReadOnlyRecommended properties.

    reportOption.ReportModel.ExcelOptions = new BoldReports.Writer.ExcelOptions()
    {
        ReadOnlyRecommended = true,
        ExcelSheetProtection = Syncfusion.XlsIO.ExcelSheetProtection.DeletingColumns
    };

CSV export options

The CsvOptions allows you to change encoding, delimiters, qualifiers, extension, and line break of a CSV exported document.

    reportOption.ReportModel.CsvOptions = new BoldReports.Writer.CsvOptions()
    {
        Encoding = System.Text.Encoding.Default,
        FieldDelimiter = ",",
        UseFormattedValues = false,
        Qualifier = "#",
        RecordDelimiter = "@",
        SuppressLineBreaks = true,
        FileExtension = ".txt"
    };

Password protect exported document

Allows you protect the exported document such as PDF, Word, Excel, and PowerPoint from unauthorized users by encrypting the document using encryption password. The following code snippet illustrates how to encrypt the exported document with user-defined password.

    public void OnInitReportOptions(ReportViewerOptions reportOption)
    {
        //PDF encryption

        reportOption.ReportModel.PDFOptions = new BoldReports.Writer.PDFOptions();
        reportOption.ReportModel.PDFOptions.Security = new Syncfusion.Pdf.Security.PdfSecurity()
        {
            UserPassword = "password"
        };

        //Word encryption
        reportOption.ReportModel.WordOptions = new BoldReports.Writer.WordOptions()
        {
            EncryptionPassword = "password"
        };

        //Excel encryption

        reportOption.ReportModel.ExcelOptions = new BoldReports.Writer.ExcelOptions()
        {
            PasswordToModify = "password",
            PasswordToOpen = "password"
        };
    }

Password protection is not supported for HTML export format.