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]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]Preparing the Designer and Viewer Applications
  [Expand]WinForms Designer
  [Expand]WinForms Viewer
  [Collapse]Web Dashboard
    Supported Browsers
    Prerequisites
    Microsoft Azure Specifics
    Display Message Texts for Callback Errors
   [Expand]ASP.NET Dashboard Control
   [Expand]ASP.NET MVC Dashboard Extension
    Manage Exporting Capabilities
    Manage Dashboard State
    Manage Interactivity Capabilities
    Manage Dashboard Parameters
    Customize Dashboard Colors
    Obtaining Underlying and Displayed Data
   [Expand]Customize the Web Dashboard using Extensions
    Access to Underlying Widgets
   [Expand]UI Elements
    Security Considerations
  [Expand]Web Viewer
 [Expand]Creating Dashboards
 [Expand]Examples
  Video Tutorials
  End-User Capabilities
  Localization
 [Expand]Redistribution and Deployment
 [Expand]Member Tables
 [Expand]API Reference
[Expand]eXpressApp Framework
[Expand]CodeRush
[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 export using the ASPxDashboardExporter class.

Expanded API

The ASPxDashboard control exposes an API that allows you to customize default export options, export dashboard and dashboard items, etc.

Server-side API

Description

ASPxDashboard.AllowExportDashboard
DashboardExtensionSettings.AllowExportDashboard
Gets or sets whether the entire dashboard can be exported by end-users.
ASPxDashboard.AllowExportDashboardItems
DashboardExtensionSettings.AllowExportDashboardItems
Gets or sets whether the dashboard items can be exported by end-users.
ASPxDashboard.PdfExportOptions
DashboardExtensionSettings.PdfExportOptions
Provides access to options related to exporting a dashboard/dashboard item to the PDF format.
ASPxDashboard.ImageExportOptions
DashboardExtensionSettings.ImageExportOptions
Provides access to options related to exporting a dashboard/dashboard item to an image.
ASPxDashboard.ExcelExportOptions
DashboardExtensionSettings.ExcelExportOptions
Provides access to options related to exporting a dashboard item to the Excel format.
ASPxDashboard.CustomExport
DashboardConfigurator.CustomExport
Allows you to customize the exported document.

Client-side 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.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.
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 in the resulting document. To learn more, refer to the ASPxDashboardExporter class description.

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?​​​​​​​