Skip to main content

DashboardDesigner.ExportDashboardItemToPdf(String, String, DashboardPdfExportOptions) Method

Exports the dashboard item to the specified file in PDF format using the specified PDF-specific options.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v24.2.Win.dll

NuGet Package: DevExpress.Win.Dashboard

#Declaration

public void ExportDashboardItemToPdf(
    string dashboardItemName,
    string filePath,
    DashboardPdfExportOptions options
)

#Parameters

Name Type Description
dashboardItemName String

A String that is the component name of the dashboard item to be exported.

filePath String

A String that specifies the path to the PDF file.

options DashboardPdfExportOptions

A DashboardPdfExportOptions object which specifies the PDF export options to be applied when the dashboard item is exported.

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