Export

20 Feb 201921 minutes to read

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

Export event handling

You can show the progress information, when the exporting takes long time to complete using the exportProgressChanged event.

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

  • javascript
  • <script type="text/javascript">
                $(function () {
                    $("#viewer").ejReportViewer(
                        {
                            reportServiceUrl: "/api/ReportsApi",
                            reportPath: '~/App_Data/Sales Order Detail.rdl',
                            exportProgressChanged: "onExportProgressChanged",
                        });
                });
                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 popupObj = $('#viewer').data('ejWaitingPopup');
                        popupObj.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 popupObj = $('#viewer').data('ejWaitingPopup');
                                    popupObj.setModel({ text: "Preparing exporting document.." + progressPercentage + " % completed.. Please wait..." });
                                }
                            }
                        }
                    }
    
                    args.handled = true;
                }
            </script>

    Change Excel and Word export format

    This allows you to change the default file format to any other file format using the excelFormat and wordFormat properties. The following code sample changes the default versions.

  • javascript
  • <script type="text/javascript">
                $(function () {
                    $("#viewer").ejReportViewer({
                        reportServiceUrl: "/api/ReportsApi",
                        reportPath: '~/App_Data/Sales Order Detail.rdl',
                        exportSettings: {
                            excelFormat: ej.ReportViewer.ExcelFormats.Excel2013,
                            wordFormat: ej.ReportViewer.WordFormats.Word2013
                        }
                    });
                });
            </script>

    Hide specific export type for report

    Show or hide the default export types available in the component using the exportOptions property. The following code hides the HTML export type from the default export options.

  • javascript
  • <script type="text/javascript">
                $(function () {
                    $("#viewer").ejReportViewer(
                        {
                            reportServiceUrl: "/api/ReportsApi",
                            reportPath: '~/App_Data/Sales Order Detail.rdl',
                            exportSettings: { exportOptions: ej.ReportViewer.ExportOptions.All & ~ej.ReportViewer.ExportOptions.Html & ~ej.ReportViewer.ExportOptions.Word }
                        });
                });
            </script>

    PDF export options

    The PDFOptions provides properties to manage PDF export behaviors. You have to 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.

  • c#
  • public void OnInitReportOptions(ReportViewerOptions reportOption)
            {
                reportOption.ReportModel.PDFOptions = new Syncfusion.EJ.ReportWriter.PDFOptions()
                {
                    EnableComplexScript = true
                };
            }

    PDF Conformance

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

  • c#
  • public void OnInitReportOptions(ReportViewerOptions reportOption)
            {
                reportOption.ReportModel.PDFOptions = new Syncfusion.EJ.ReportWriter.PDFOptions()
                {
                    PdfConformanceLevel = Syncfusion.Pdf.PdfConformanceLevel.Pdf_A1B
                };
            }

    Add custom PDF fonts

    This allows you to have custom fonts in the PDF exported document by adding the font streams to Fonts collection in PDFOptions instance.

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

    NOTE

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

  • c#
  • public void OnInitReportOptions(ReportViewerOptions reportOption)
            {
                reportOption.ReportModel.PDFOptions = new Syncfusion.EJ.ReportWriter.PDFOptions()
                {
                    //Load Missing font stream
                    Fonts = new Dictionary<string, System.IO.Stream>
                    {
                        { "Segoe UI", System.IO.File.OpenRead(System.Web.Hosting.HostingEnvironment.MapPath(@"~/App_Data/font_symbols.ttf")) },
                    }
                };
            }

    IMPORTANT

    Any fonts used in the report definition that is not installed or available in the local system, then you must load the font stream. In the above code, loaded font_symbols font stream to export 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.

  • c#
  • reportOption.ReportModel.WordOptions = new Syncfusion.EJ.ReportWriter.WordOptions()
                {
                    FormatType = Syncfusion.EJ.ReportWriter.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 as TopLevel. The ParagraphSpacing is the distance value added between two elements in the document.

  • c#
  • reportOption.ReportModel.WordOptions = new Syncfusion.EJ.ReportWriter.WordOptions()
                {
                    LayoutOption = Syncfusion.EJ.ReportWriter.WordLayoutOptions.TopLevel,
                    ParagraphSpacing = new Syncfusion.EJ.ReportWriter.ParagraphSpacing()
                    {
                        Bottom = 0.5f,
                        Top = 0.5f
                    },
                };

    IMPORTANT

    A paragraph element is inserted between two tables in the exported document to overcome word document auto merging behavior.

    NOTE

    The table in 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, added an empty paragraph between two tables.

    Protecting document from editing

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

    1. AllowOnlyComments: You can add or modify only the comments in the Word document.
    2. AllowOnlyFormFields: You can modify the form field values in the Word document.
    3. AllowOnlyRevisions: You can accept or reject the revisions in the Word document.
    4. AllowOnlyReading: You can only view the content in the Word document.
    5. NoProtection: You can access or edit the Word document contents as normally.
  • c#
  • reportOption.ReportModel.WordOptions = new Syncfusion.EJ.ReportWriter.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.

  • c#
  • reportOption.ReportModel.ExcelOptions = new Syncfusion.EJ.ReportWriter.ExcelOptions()
                {
                    ExcelSaveType = Syncfusion.EJ.ReportWriter.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 as IgnoreCellMerge.

  • c#
  • reportOption.ReportModel.ExcelOptions = new Syncfusion.EJ.ReportWriter.ExcelOptions()
                {
                    LayoutOption = Syncfusion.EJ.ReportWriter.ExcelLayoutOptions.IgnoreCellMerge,
                };

    Protecting document from editing

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

  • c#
  • reportOption.ReportModel.ExcelOptions = new Syncfusion.EJ.ReportWriter.ExcelOptions()
                {
                    ReadOnlyRecommended = true,
                    ExcelSheetProtection = ExcelSheetProtection.DeletingColumns,
                };

    PowerPoint export options

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

  • c#
  • reportOption.ReportModel.PPTOptions = new Syncfusion.EJ.ReportWriter.PPTOptions()
                {
                    FormatType = Syncfusion.EJ.ReportWriter.PPTSaveType.PowerPoint2013,
                };

    CSV export options

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

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

    HTML export options

    You can hide the separator added at the end of each page by setting the HidePageSeparator property to true.

  • c#
  • reportOption.ReportModel.HTMLOptions = new Syncfusion.EJ.ReportWriter.HTMLOptions()
                {
                    HidePageSeparator = true
                };

    Password protect exported document

    This allows you to 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 the user defined password.

  • c#
  • public void OnInitReportOptions(ReportViewerOptions reportOption)
            {
                //PDF encryption
    
                reportOption.ReportModel.PDFOptions = new Syncfusion.EJ.ReportWriter.PDFOptions();
                reportOption.ReportModel.PDFOptions.Security = new Syncfusion.Pdf.Security.PdfSecurity()
                {
                    UserPassword = "password"
                };
    
                //Word encryption
                reportOption.ReportModel.WordOptions = new Syncfusion.EJ.ReportWriter.WordOptions()
                {
                    EncryptionPassword = "password"
                };
    
                //Excel encryption
    
                reportOption.ReportModel.ExcelOptions = new Syncfusion.EJ.ReportWriter.ExcelOptions()
                {
                    PasswordToModify = "password",
                    PasswordToOpen = "password"
                };
                //PPT encryption
                reportOption.ReportModel.PPTOptions = new Syncfusion.EJ.ReportWriter.PPTOptions()
                {
                    EncryptionPassword = "password"
                };
            }

    NOTE

    Password protection is not supported for HTML export format.