Printing and Exporting

  • 2 min to read

The WinForms Designer provides end-users with the capability to print or export an entire dashboard and individual items. You can also use an API to perform the export, customize printing/exporting settings, etc.

API Description
DashboardDesigner.AllowPrintDashboard Gets or sets whether end-users can print or export a dashboard.
DashboardDesigner.AllowPrintDashboardItems Gets or sets whether end-users can print or export dashboard items.
DashboardDesigner.PrintPreviewOptions Provides access to options related to printing a dashboard/dashboard item.
DashboardDesigner.PdfExportOptions Provides access to options related to exporting a dashboard/dashboard item to the PDF format.
DashboardDesigner.ImageExportOptions Provides access to options related to exporting a dashboard/dashboard item to an image.
DashboardDesigner.ExcelExportOptions Provides access to options related to exporting a dashboard item to the Excel format.
DashboardDesigner.PrintPreviewType Gets or sets the type of Print Preview used to preview dashboard items or the entire dashboard.
DashboardDesigner.ShowPrintPreview Invokes the Print Preview, which shows the print preview of the dashboard.
DashboardDesigner.ShowRibbonPrintPreview Invokes the Ribbon Print Preview Form, which shows the print preview of the dashboard.
DashboardDesigner.ShowExportDashboardDialog Invokes the dialog that allows end-users to export the entire dashboard to the specified format.
DashboardDesigner.ShowExportDashboardItemDialog Invokes the dialog that allows end-users to export the dashboard item to the specified format.
DashboardDesigner.PrintPreviewShowing Allows you to customize the Print Preview window at runtime.
DashboardDesigner.ExportToPdf Exports a dashboard to the specified stream in PDF format.
DashboardDesigner.ExportToImage Exports a dashboard to the specified stream in Image format.
DashboardDesigner.ExportToExcel Exports dashboard data to the specified stream in Excel format.
DashboardDesigner.ExportDashboardItemToPdf Exports the dashboard item to the specified stream in PDF format.
DashboardDesigner.ExportDashboardItemToImage Exports the dashboard item to the specified stream in Image format.
DashboardDesigner.ExportDashboardItemToExcel Exports the dashboard item to the specified stream in Excel format.
DashboardDesigner.ExportFormShowing Occurs when the Export Form is about to be displayed, and allows you to cancel the action.
DashboardDesigner.BeforeExportDocument Allows you to hide specific dashboard items when printing or exporting the entire dashboard.
DashboardDesigner.CustomExport Allows you to customize the exported document.
DashboardDesigner.CustomizeExportDocument Allows you to customize the exported document.

How to: Add Custom Information to the Exported Dashboard at Runtime using the CustomExport Event