The requested page is not available for the requested platform. You are viewing the content for Default platform.

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.v19.1.Win.dll

Declaration

public void ExportDashboardItemToPdf(
    string dashboardItemName,
    string filePath,
    DashboardPdfExportOptions options
)
Public Sub ExportDashboardItemToPdf(
    dashboardItemName As String,
    filePath As String,
    options As DashboardPdfExportOptions
)

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.

Examples

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