How to: Customize the Report Export Options

• Oct 26, 2022
• 2 minutes to read

This example demonstrates how to access the ExportOptions object, which stores the document export options for different formats. These options are applied when you export a report from a Report Viewer in both WinForms and ASP.NET Web Forms applications.

Note

ASP.NET Core Blazor applications do not support the approach described in this topic.

In this topic, it is assumed that you have an XAF application that uses the Reports V2 Module, and you have created one or more reports (see Reports V2 Module Overview).

• In the platform-agnostic module, declare the following helper class.

  C#

  using DevExpress.XtraPrinting;
  // ...
  public static class ExportConfigurator {
      public static void Setup(ExportOptions exportOptions) {
          SetHtmlOptions(exportOptions.Html);
          SetPdfOptions(exportOptions.Pdf);
          SetXlsOptions(exportOptions.Xls);
      }
      private static void SetXlsOptions(XlsExportOptions xlsExportOptions) {
          // XLS-specific options: 
          xlsExportOptions.SheetName = "CustomXlsSheetTitle";
          xlsExportOptions.ShowGridLines = true;
      }
      private static void SetPdfOptions(PdfExportOptions pdfExportOptions) {
          // PDF-specific options: 
          pdfExportOptions.DocumentOptions.Title = "CustomPdfTitle";
          pdfExportOptions.ImageQuality = PdfJpegImageQuality.Medium;
      }
      private static void SetHtmlOptions(HtmlExportOptions htmlExportOptions) {
          // HTML-specific options: 
          htmlExportOptions.Title = "CustomHtmlTitle";
          htmlExportOptions.ExportMode = HtmlExportMode.SingleFilePageByPage;
          htmlExportOptions.PageBorderColor = System.Drawing.Color.Gray;
          htmlExportOptions.EmbedImagesInHTML = true;
      }
  }
  

  VB.NET

  Imports DevExpress.XtraPrinting
  ' ... 
  Public NotInheritable Class ExportConfigurator
      Private Sub New()
      End Sub
      Public Shared Sub Setup(ByVal exportOptions As ExportOptions)
          SetHtmlOptions(exportOptions.Html)
          SetPdfOptions(exportOptions.Pdf)
          SetXlsOptions(exportOptions.Xls)
      End Sub
      Private Shared Sub SetXlsOptions(ByVal xlsExportOptions As XlsExportOptions)
          ' XLS-specific options:  
          xlsExportOptions.SheetName = "CustomXlsSheetTitle"
          xlsExportOptions.ShowGridLines = True
      End Sub
      Private Shared Sub SetPdfOptions(ByVal pdfExportOptions As PdfExportOptions)
          ' PDF-specific options:  
          pdfExportOptions.DocumentOptions.Title = "CustomPdfTitle"
          pdfExportOptions.ImageQuality = PdfJpegImageQuality.Medium
      End Sub
      Private Shared Sub SetHtmlOptions(ByVal htmlExportOptions As HtmlExportOptions)
          ' HTML-specific options:  
          htmlExportOptions.Title = "CustomHtmlTitle"
          htmlExportOptions.ExportMode = HtmlExportMode.SingleFilePageByPage
          htmlExportOptions.PageBorderColor = System.Drawing.Color.Gray
          htmlExportOptions.EmbedImagesInHTML = True
      End Sub
  End Class
  

• In the Module.cs (Module.vb) file, override the ModuleBase.Setup method, find the ReportsModuleV2 instance using the static ReportsModuleV2.FindReportsModule method and subscribe to the ReportDataSourceHelper.BeforeShowPreview event.

  C#

  using DevExpress.ExpressApp.ReportsV2;
  // ...
  public override void Setup(ApplicationModulesManager moduleManager) {
      base.Setup(moduleManager);
      ReportsModuleV2 reportsModule = ReportsModuleV2.FindReportsModule(moduleManager.Modules);
      if(reportsModule != null) {
          reportsModule.ReportsDataSourceHelper.BeforeShowPreview += ReportsDataSourceHelper_BeforeShowPreview;
      }
  }
  

  VB.NET

  Imports DevExpress.ExpressApp.ReportsV2
  ' ...
  Public Overrides Sub Setup(ByVal moduleManager As ApplicationModulesManager)
      MyBase.Setup(moduleManager)
      Dim reportsModule As ReportsModuleV2 = ReportsModuleV2.FindReportsModule(moduleManager.Modules)
      If reportsModule IsNot Nothing Then
          reportsModule.ReportsDataSourceHelper.BeforeShowPreview += ReportsDataSourceHelper_BeforeShowPreview
      End If
  End Sub
  

• In the event handler, execute the ExportConfigurator.Setup static helper method implemented in the first step.

  C#

  private void ReportsDataSourceHelper_BeforeShowPreview(object sender, BeforeShowPreviewEventArgs e) {
      ExportConfigurator.Setup(e.Report.ExportOptions);
  }
  

  VB.NET

  Private Sub ReportsDataSourceHelper_BeforeShowPreview(ByVal sender As Object, ByVal e As BeforeShowPreviewEventArgs)
      ExportConfigurator.Setup(e.Report.ExportOptions)
  End Sub