DashboardPdfExportOptions Class

Contains options related to exporting a dashboard/dashboard item to PDF format.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v22.1.Core.dll

Declaration

C#

public class DashboardPdfExportOptions :
    IDashboardPdfExportOptions,
    IDashboardReportOptions,
    IDashboardExportOptions

VB.NET

Public Class DashboardPdfExportOptions
    Implements IDashboardPdfExportOptions,
               IDashboardReportOptions,
               IDashboardExportOptions

Related API Members

The following members return DashboardPdfExportOptions objects:

• ASPxDashboard.PdfExportOptions
• BeforeExportDocumentEventArgs.PdfExportOptions
• BeforeExportDocumentWebEventArgs.PdfExportOptions
• CustomExportBaseEventArgs.PdfExportOptions
• CustomExportBaseWebEventArgs.PdfExportOptions
• DashboardControl.PdfExportOptions
• DashboardDesigner.PdfExportOptions
• DashboardExtensionSettings.PdfExportOptions
• DashboardViewer.PdfExportOptions
• IDashboardControl.PdfExportOptions

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 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.

C#

using DevExpress.DashboardCommon;
// ...
            dashboardDesigner1.ExportDashboardItemToPdf("chartDashboardItem1", @"c:\temp\ExportedDocument.pdf", new DashboardPdfExportOptions() {
                    ChartSizeMode = ChartExportSizeMode.Zoom,
                    PageLayout = DashboardExportPageLayout.Portrait,
                    PaperKind = System.Drawing.Printing.PaperKind.A3
                }
            );

VB.NET

Imports DevExpress.DashboardCommon
' ...
            dashboardDesigner1.ExportDashboardItemToPdf("chartDashboardItem1", "c:\temp\ExportedDocument.pdf", New DashboardPdfExportOptions() With { _
                Key .ChartSizeMode = ChartExportSizeMode.Zoom, _
                Key .PageLayout = DashboardExportPageLayout.Portrait, _
                Key .PaperKind = System.Drawing.Printing.PaperKind.A3 _
            })

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardPdfExportOptions class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

aspnet-mvc-dashboard-how-to-implement-server-side-export-t590027/CS/MvcDashboard_ServerExport/Controllers/HomeController.cs#L23

DashboardPdfExportOptions pdfOptions = new DashboardPdfExportOptions();
pdfOptions.ExportFilters = true;

aspxdashboard-how-to-implement-server-side-export-t500219/CS/ASPxDashboard_ServerExport/Default.aspx.cs#L36

DashboardPdfExportOptions pdfOptions = new DashboardPdfExportOptions();
pdfOptions.ExportFilters = true;

how-to-export-web-dashboard-into-pdf-with-different-filter-values-on-different-pages-t511362/CS/ASPxDashboard_ServerExport/Default.aspx.cs#L36

}
DashboardPdfExportOptions pdfOptions = new DashboardPdfExportOptions();
pdfOptions.ShowTitle = DevExpress.Utils.DefaultBoolean.False;

VB.NET

aspnet-mvc-dashboard-how-to-implement-server-side-export-t590027/VB/MvcDashboard_ServerExport/Controllers/HomeController.vb#L21

dbState.LoadFromJson(DashboardState)
Dim pdfOptions As New DashboardPdfExportOptions()
pdfOptions.ExportFilters = True

aspxdashboard-how-to-implement-server-side-export-t500219/VB/ASPxDashboard_ServerExport/Default.aspx.vb#L32

Dim pdfOptions As New DashboardPdfExportOptions()
pdfOptions.ExportFilters = True

how-to-export-web-dashboard-into-pdf-with-different-filter-values-on-different-pages-t511362/VB/ASPxDashboard_ServerExport/Default.aspx.vb#L35

End If
Dim pdfOptions As New DashboardPdfExportOptions()
pdfOptions.ShowTitle = DevExpress.Utils.DefaultBoolean.False

Inheritance

Object

DashboardPdfExportOptions