Manage Exporting Capabilities

Important

This documentation applies to v16.2. Starting with v17.1, the ASPxDashboardViewer control is in maintenance mode. In v19.1, the new Web Dashboard Control replaces the old Web Dashboard Viewer. This means that the Web Dashboard Viewer will not be included in our installation packages. See our blog post for more information.

Refer to the following KB articles to learn how to migrate to ASPxDashboard / ASP.NET MVC Dashboard:

The Web Viewer provides end-users with the capability to export an entire dashboard and individual items. You can also use an API to perform export, customize exporting settings, etc.

Server-side API

Description

ASPxDashboardViewer.AllowExportDashboard

DashboardViewerSettings.AllowExportDashboard

Gets or sets whether end-users can export a dashboard.

ASPxDashboardViewer.AllowExportDashboardItems

DashboardViewerSettings.AllowExportDashboardItems

Gets or sets whether end-users can export dashboard items.

ASPxDashboardViewer.PdfExportOptions

DashboardViewerSettings.PdfExportOptions

Provides access to options related to exporting a dashboard/dashboard item to the PDF format.

ASPxDashboardViewer.ImageExportOptions

DashboardViewerSettings.ImageExportOptions

Provides access to options related to exporting a dashboard/dashboard item to an image.

ASPxDashboardViewer.ExcelExportOptions

DashboardViewerSettings.ExcelExportOptions

Provides access to options related to exporting a dashboard item to the Excel format.

ASPxDashboardViewer.CustomExport

DashboardSourceModel.CustomExport

Allows you to customize the exported document.

ASPxDashboardViewer.CustomizeExportDocument

DashboardSourceModel.CustomizeExportDocument

Allows you to customize the exported document.

Client-side API

Description

ASPxClientDashboardViewer.ExportToPdf

Exports a dashboard to a PDF file and writes it to the Response.

ASPxClientDashboardViewer.ExportToImage

Exports a dashboard to an Image file and writes it to the Response.

ASPxClientDashboardViewer.ExportToExcel

Exports dashboard data to the specified file in Excel format.

ASPxClientDashboardViewer.ExportDashboardItemToPdf

Exports a dashboard item to a PDF file and writes it to the Response.

ASPxClientDashboardViewer.ExportDashboardItemToImage

Exports a dashboard item to an Image file and writes it to the Response.

ASPxClientDashboardViewer.ExportDashboardItemToExcel

Exports a dashboard item to an Excel file and writes it to the Response.

ASPxClientDashboardViewer.GetPdfExportOptions

Allows you to obtain options related to exporting a dashboard/dashboard item to the PDF format.

ASPxClientDashboardViewer.GetImageExportOptions

Allows you to obtain options related to exporting a dashboard/dashboard item to an image.

ASPxClientDashboardViewer.GetExcelExportOptions

Allows you to obtain options related to exporting a dashboard/dashboard item to the Excel format.

ASPxClientDashboardViewer.SetPdfExportOptions

Allows you to specify options related to exporting a dashboard/dashboard item to the PDF format.

ASPxClientDashboardViewer.SetImageExportOptions

Allows you to specify options related to exporting a dashboard/dashboard item to an image.

ASPxClientDashboardViewer.SetExcelExportOptions

Allows you to specify options related to exporting a dashboard/dashboard item to the Excel format.