Skip to main content
A newer version of this page is available. .

Printing and Exporting

  • 5 minutes to read

To print or export the entire dashboard, click the Export To button in the dashboard title area and choose the required action.

WPF Print Command

  • Print Preview - invokes a Print Preview dialog that allows you to specify print options and print the dashboard:

WPF Print Preview Dialog

  • Export to PDF - Invokes a dialog that allows end-users to export a dashboard to a PDF file. The following options are available:

    • Page Layout - Specifies the page orientation used to export a dashboard. You can select between Portrait, Landscape, and Auto. Note that in the Auto mode, page orientation is selected automatically depending on the horizontal and vertical sizes of a dashboard.
      • Size - Specifies the standard paper size (for instance, Letter or A4).
      • Show Title - Specifies whether to apply the dashboard title to the exported document title.
      • Title - Specifies the title of the exported document.
      • Scale Mode - Specifies the mode for scaling when exporting a dashboard.

        Note

        Note that this option is in effect when Page Layout is set to a value different from Auto.

      • Scale Factor - Specifies the scale factor (in fractions of 1) by which a dashboard is scaled.

        Note

        This option is in effect if Scale Mode is set to Use Scale Factor.

      • Auto Fit Page Count - Specifies the number of horizontal/vertical pages spanning the total width/height of a dashboard.

        Note

        This option is in effect if Scale Mode is set to Auto Fit to Page Width.

      • Include Filters - Allows you to include master filter values to the exported document.
      • Include Parameters - Allows you to include parameter values to the exported document.
      • Position - Specifies the position of the master filter and parameter values in the exported document. You can select between Below and Separate Page.

    Specify the required options in this dialog and click the Export button to export the dashboard. To reset changes to the default values, click the Reset button.

  • Export to Image - Invokes a dialog that allows end-users to export a dashboard to an image in the specified format. The following options are available:

    • Image Format - Specifies the image format in which the dashboard is exported. The following formats are available: PNG, JPEG, and GIF.
      • Show Title - Specifies whether to apply the dashboard title to the exported document title.
      • Title - Specifies the title of the exported document.
      • Resolution (dpi) - Specifies the resolution (in dpi) used to export a dashboard.
      • Include Filters - Allows you to include master filter values to the exported document.
      • Include Parameters - Allows you to include parameter values to the exported document.

    Specify the required options in this dialog and click the Export button to export the dashboard. To reset changes to the default values, click the Reset button.

  • Export to Excel - Invokes a dialog that allows end-users to export a dashboard’s data to the Excel file. The following options are available:

    • Excel Format - Specifies the Excel workbook format in which the dashboard’s data is exported. You can select between XLSX and XLS.
      • Include Filters - Allows you to include master filter values to the exported document.
      • Include Parameters - Allows you to include parameter values to the exported document.
      • Position - Specifies the position of the master filter and parameter values in the exported document. You can select between Below and Separate Sheet.

    Specify the required options in this dialog and click the Export button to export the dashboard. To reset changes to the default values, click the Reset button.

To print or export a dashboard item, click the Export To button in its caption and choose the required action.

  • Export to PDF - Invokes a dialog that allows end-users to export a dashboard to a PDF file with specific options.
  • Export to Image - Invokes a dialog that allows end-users to export a dashboard to an image in the specified format.
  • Export to Excel - Invokes a dialog that allows end-users to export a dashboard item’s data to the Excel workbook or CSV file.

To learn more about printing/exporting specifics of different dashboard items, see the Printing and Exporting topic for the required dashboard item.

Printing and Exporting API

The DashboardDesigner control exposes an API that allows you to customize default export options, export dashboard and dashboard items, etc. To learn more, see Manage Printing and Exporting Capabilities

API Description
DashboardControl.ShowPrintPreview Invokes the Print Preview, which shows the print preview of the dashboard.
DashboardControl.ShowDashboardItemPrintPreview Invokes the Print Preview, which shows the print preview of the dashboard item.
DashboardControl.PdfExportOptions Provides access to options related to exporting a dashboard/dashboard item to the PDF format.
DashboardControl.ImageExportOptions Provides access to options related to exporting a dashboard/dashboard item to an image.
DashboardControl.ExcelExportOptions Provides access to options related to exporting a dashboard item to the Excel format.
DashboardControl.ExportToPdf Exports a dashboard to the specified stream in PDF format using the specified PDF-specific options.
DashboardControl.ExportToImage Exports a dashboard to the specified stream in Image format using the specified image-specific options.
DashboardControl.ExportToExcel Exports dashboard data to the specified stream in Excel format.
DashboardControl.ExportDashboardItemToPdf Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options.
DashboardControl.ExportDashboardItemToImage Exports the dashboard item to the specified stream in Image format using the specified image options.
DashboardControl.ExportDashboardItemToExcel Exports the dashboard item to the specified stream in Excel format using specified export options.
DashboardControl.BeforeExportDocument Allows you to hide specific dashboard items when printing or exporting the entire dashboard.
DashboardControl.CustomExport Allows you to customize the exported document.
DashboardControl.CustomizeExportDocument Allows you to customize the exported document.