Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Collapse]Dashboard
 [Expand]Getting Started
 [Expand]Basic Concepts and Terminology
 [Expand]Main Features
 [Collapse]Building the Designer and Viewer Applications
  [Expand]WinForms Designer
  [Expand]WinForms Viewer
  [Collapse]Web Dashboard
    Web Dashboard Technical Overview
    Supported Browsers
    Required Client Libraries
   [Collapse]ASP.NET Dashboard Control
     Adding the ASPxDashboard Control
     Server-Side API Overview
     Preparing a Dashboard Storage
     Register Default Data Sources
     Register Default Data Connections
     Designer and Viewer Modes
     Loading a Dashboard
     Appearance Customization
     Manage Exporting Capabilities
     Manage Dashboard State
     Manage Interactivity Capabilities
     Manage Dashboard Parameters
     Customize Dashboard Colors
     Access to Underlying Widgets
     Obtaining Underlying and Displayed Data
     Client-Side Functionality
   [Expand]ASP.NET MVC Dashboard Extension
   [Expand]ASP.NET Core MVC Dashboard Control
   [Expand]HTML5 JavaScript Dashboard Control
   [Expand]Customize the Web Dashboard using Extensions
    Mobile Layout (CTP)
    Security Considerations
   [Expand]Miscellaneous
   [Expand]UI Elements
  [Expand]WPF Viewer (CTP)
  [Expand]Web Viewer
 [Expand]Creating Dashboards
 [Expand]Examples
 [Expand]Design-Time Features
  Video Tutorials
  End-User Documentation
  Localization
 [Expand]Redistribution and Deployment
 [Expand]Member Tables
 [Expand]API Reference
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Manage Exporting Capabilities

The Web Dashboard allows end-users to export an entire dashboard or individual dashboard items. You can also implement server-side exporting using the ASPxDashboardExporter class.

Expanded Server-Side API

The ASPxDashboard control's server-side API allows you to customize the default export options, customize export documents at runtime, etc.

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.
How to: Add Custom Information to the Exported Dashboard at Runtime using the CustomExport Event

Expanded Client-Side API

You can use the ASPxDashboard control's client-side API for exporting to various formats, customizing export options, etc.

API

Description

ASPxClientDashboard.ExportToPdf Exports a dashboard to a PDF file with the specified export options and writes it to the Response.
ASPxClientDashboard.ExportToImage Exports a dashboard to an Image file with the specified export options 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 with the specified export options and writes it to the Response.
ASPxClientDashboard.ExportDashboardItemToImage Exports a dashboard item to an Image file with the specified export options and writes it to the Response.
ASPxClientDashboard.ExportDashboardItemToExcel Exports a dashboard item to an Excel file with the specified export options 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.
How to: Add Custom Information to the Exported Dashboard at Runtime using the CustomExport Event

Expanded Implement Server-Side Export

The ASPxDashboardExporter class allows you to implement server export for the ASP.NET Dashboard Control and ASP.NET MVC Dashboard Extension. You can specify a dashboard state and export options to be applied to the resulting document. Refer to the ASPxDashboardExporter class description for more information.

Show Me

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=T500219.

This example demonstrates how to export a dashboard displayed in ASPxDashboard on the server side using the ASPxDashboardExporter class. The following API is used to implement this capability.

How would you rate this topic?​​​​​​​