Member Table: Printing and Exporting

• Mar 28, 2019
• 9 min to read

The following tables list members related to the dashboard print and export capabilities.

• Desktop
• Web

Desktop

• WinForms - DashboardDesigner

  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.

• WinForms - DashboardViewer

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

• WPF - DashboardControl

  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.
  DashboardControl.ExportToImage	Exports a dashboard to the specified stream in Image format.
  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.
  DashboardControl.ExportDashboardItemToImage	Exports the dashboard item to the specified stream in Image format.
  DashboardControl.ExportDashboardItemToExcel	Exports the dashboard item to the specified stream in Excel format.
  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.

Web

Server-Side API

• ASP.NET Web Forms - ASPxDashboard

  API	Description
  ASPxDashboard.AllowExportDashboard	Gets or sets whether the entire dashboard can be exported by end-users.
  ASPxDashboard.AllowExportDashboardItems	Gets or sets whether the dashboard items can be exported by end-users.
  ASPxDashboard.PdfExportOptions	Provides access to options related to exporting a dashboard/dashboard item to the PDF format.
  ASPxDashboard.ImageExportOptions	Provides access to options related to exporting a dashboard/dashboard item to an image.
  ASPxDashboard.ExcelExportOptions	Provides access to options related to exporting a dashboard item to the Excel format.
  ASPxDashboard.BeforeExportDocument	Allows you to hide specific dashboard items when exporting the entire dashboard.
  ASPxDashboard.CustomExport	Allows you to customize the exported document.
  ASPxDashboard.CustomizeExportDocument	Allows you to customize the exported document.
  ASPxDashboardExporter Constructor	Initializes a new instance of the ASPxDashboardExporter class for the specified DashboardConfigurator instance.

• ASP.NET MVC - MVCxDashboard

  API	Description
  DashboardExtensionSettings.AllowExportDashboard	Gets or sets whether end-users can export a dashboard.
  DashboardExtensionSettings.AllowExportDashboardItems	Gets or sets whether end-users can export dashboard items.
  DashboardExtensionSettings.PdfExportOptions	Provides access to options related to exporting a dashboard/dashboard item to the PDF format.
  DashboardExtensionSettings.ImageExportOptions	Provides access to options related to exporting a dashboard/dashboard item to an image.
  DashboardExtensionSettings.ExcelExportOptions	Provides access to options related to exporting a dashboard item to the Excel format.
  DashboardConfigurator.BeforeExportDocument	Allows you to hide specific dashboard items when exporting the entire dashboard.
  DashboardConfigurator.CustomExport	Allows you to customize the exported document.
  DashboardConfigurator.CustomizeExportDocument	Allows you to customize the exported document.
  WebDashboardExporter.ExportDashboardItemToExcel	Exports the dashboard item to the specified stream in Excel format.
  WebDashboardExporter.ExportDashboardItemToImage	Exports the dashboard item to the specified stream in Image format.
  WebDashboardExporter.ExportDashboardItemToPdf	Exports the dashboard item to the specified stream in PDF format.
  WebDashboardExporter.ExportToExcel	Exports a dashboard to the specified stream in Excel format.
  WebDashboardExporter.ExportToImage	Exports a dashboard to the specified stream in Image format.
  WebDashboardExporter.ExportToPdf	Exports a dashboard to the specified stream in PDF format.

• ASP.NET Core - DashboardExportOptionBuilder

  API	Description
  DashboardExportOptionBuilder.AllowExportDashboard	Specifies whether end-users can export a dashboard.
  DashboardExportOptionBuilder.AllowExportDashboardItems	Specifies whether the dashboard items can be exported by end-users.
  DashboardExportOptionBuilder.PdfExportOptions	Contains options which define how the dashboard item is exported to the PDF format.
  DashboardExportOptionBuilder.ImageExportOptions	Contains options which define how the dashboard item is exported to the Image format.
  DashboardExportOptionBuilder.ExcelExportOptions	Contains options which define how the dashboard item is exported to the Excel format.
  DashboardExportOptionBuilder.OnExportDialogHidden	A handler for the event occurring when the export dialog is hidden.
  DashboardExportOptionBuilder.OnExportDialogShowing	A handler for the event occurring before the export dialog is shown.
  DashboardExportOptionBuilder.OnExportDialogShown	A handler for the event occurring after the export dialog is shown.
  WebDashboardExporter.ExportDashboardItemToExcel	Exports the dashboard item to the specified stream in Excel format.
  WebDashboardExporter.ExportDashboardItemToImage	Exports the dashboard item to the specified stream in Image format.
  WebDashboardExporter.ExportDashboardItemToPdf	Exports the dashboard item to the specified stream in PDF format.
  WebDashboardExporter.ExportToExcel	Exports a dashboard to the specified stream in Excel format.
  WebDashboardExporter.ExportToImage	Exports a dashboard to the specified stream in Image format.
  WebDashboardExporter.ExportToPdf	Exports a dashboard to the specified stream in PDF format.

Client-Side API

• ASP.NET Web Forms / MVC - ASPxClientDashboard

  API	Description
  ASPxClientDashboard.ExportToPdf	Exports a dashboard to a PDF file and writes it to the Response.
  ASPxClientDashboard.ExportToImage	Exports a dashboard to an Image file and writes it to the Response.
  ASPxClientDashboard.ExportToExcel	Exports dashboard data to the specified file in Excel format.
  ASPxClientDashboard.ExportDashboardItemToPdf	Exports a dashboard item to a PDF file and writes it to the Response.
  ASPxClientDashboard.ExportDashboardItemToImage	Exports a dashboard item to an Image file and writes it to the Response.
  ASPxClientDashboard.ExportDashboardItemToExcel	Exports a dashboard item to an Excel file and writes it to the Response.
  ASPxClientDashboard.GetPdfExportOptions	Allows you to obtain options related to exporting a dashboard/dashboard item to the PDF format.
  ASPxClientDashboard.GetImageExportOptions	Allows you to obtain options related to exporting a dashboard/dashboard item to an image.
  ASPxClientDashboard.GetExcelExportOptions	Allows you to obtain options related to exporting a dashboard/dashboard item to the Excel format.
  ASPxClientDashboard.SetPdfExportOptions	Allows you to specify options related to exporting a dashboard/dashboard item to the PDF format.
  ASPxClientDashboard.SetImageExportOptions	Allows you to specify options related to exporting a dashboard/dashboard item to an image.
  ASPxClientDashboard.SetExcelExportOptions	Allows you to specify options related to exporting a dashboard/dashboard item to the Excel format.
  ASPxClientDashboard.ShowExportDashboardDialog	Invokes the dialog that allows end-users to export the entire dashboard to the specified format.
  ASPxClientDashboard.ShowExportDashboardItemDialog	Invokes the dialog that allows end-users to export the dashboard item to the specified format.

• HTML JavaScript Dashboard - DashboardExportExtension

  API	Description
  DashboardExportExtension.exportToPdf	Exports the entire dashboard to a PDF file.
  DashboardExportExtension.exportToImage	Exports the entire dashboard to an image.
  DashboardExportExtension.exportToExcel	Exports the entire dashboard to an Excel file.
  DashboardExportExtension.exportDashboardItemToPdf	Exports a dashboard item to a PDF file.
  DashboardExportExtension.exportDashboardItemToImage	Exports a dashboard item to an image.
  DashboardExportExtension.exportDashboardItemToExcel	Exports a dashboard item to an Excel file.
  DashboardExportExtension.getPdfExportOptions	Returns options related to exporting a dashboard/dashboard item to the PDF format.
  DashboardExportExtension.getImageExportOptions	Returns options related to exporting a dashboard/dashboard item to the Image format.
  DashboardExportExtension.getExcelExportOptions	Returns options related to exporting a dashboard/dashboard item to the Excel format.
  DashboardExportExtension.setPdfExportOptions	Sets options related to exporting a dashboard/dashboard item to the PDF format.
  DashboardExportExtension.setImageExportOptions	Sets options related to exporting a dashboard/dashboard item to the Image format.
  DashboardExportExtension.setExcelExportOptions	Sets options related to exporting a dashboard/dashboard item to the Excel format.
  DashboardExportExtension.showExportDashboardDialog	Invokes the dialog that allows end-users to export the entire dashboard to the specified format.
  DashboardExportExtension.showExportDashboardItemDialog	Invokes the dialog that allows end users to export the dashboard item to the specified format.