DashboardPdfExportOptions Class
Contains options related to exporting a dashboard/dashboard item to PDF format.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v24.2.Core.dll
NuGet Package: DevExpress.Dashboard.Core
#Declaration
public class DashboardPdfExportOptions :
IDashboardPdfExportOptions,
IDashboardReportOptions,
IDashboardExportOptions
#Related API Members
The following members return DashboardPdfExportOptions objects:
#Remarks
The following properties allow you to access default PDF export options for different controls.
- ASPxDashboard.PdfExportOptions / DashboardExtensionSettings.PdfExportOptions
- DashboardDesigner.PdfExportOptions
- DashboardViewer.PdfExportOptions
- DashboardControl.PdfExportOptions
Moreover, you can specify PDF options when exporting a dashboard/dashboard item using the following methods.
- WebDashboardExporter.ExportToPdf / WebDashboardExporter.ExportDashboardItemToPdf
- DashboardDesigner.ExportToPdf / DashboardDesigner.ExportDashboardItemToPdf
- DashboardViewer.ExportToPdf / DashboardViewer.ExportDashboardItemToPdf
- DashboardControl.ExportToPdf / DashboardControl.ExportDashboardItemToPdf
Note
To export a dashboard/dashboard item on the web using an API, use the Export
#Example
The following code snippet shows how to export the Chart dashboard item displayed within the DashboardDesigner using the DashboardDesigner.ExportDashboardItemToPdf method with specific PDF-export options specified.
using DevExpress.DashboardCommon;
// ...
dashboardDesigner1.ExportDashboardItemToPdf("chartDashboardItem1", @"c:\temp\ExportedDocument.pdf", new DashboardPdfExportOptions() {
ChartSizeMode = ChartExportSizeMode.Zoom,
PageLayout = DashboardExportPageLayout.Portrait,
PaperKind = System.Drawing.Printing.PaperKind.A3
}
);