Skip to main content

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

#Remarks

The following properties allow you to access default PDF export options for different controls.

Moreover, you can specify PDF options when exporting a dashboard/dashboard item using the following methods.

Note

To export a dashboard/dashboard item on the web using an API, use the ExportToPdf and ExportDashboardItemToPdf methods exposed by the ASPxClientDashboard class.

#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
                }
            );

#Inheritance

Object
DashboardPdfExportOptions
See Also