BeforeExportDocumentEventArgs.ExportAction Property

Gets the export action performed by an end-user.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public DashboardExportAction ExportAction { get; }

VB.NET

Public ReadOnly Property ExportAction As DashboardExportAction

Property Value

Type	Description
DashboardExportAction	A DashboardExportAction object that is the export action performed by an end-user.

Available values:

Name	Description
PrintPreview	An end-user invokes the Print Preview form.
ExportToPdf	An end-user executes the Export to PDF command.
ExportToImage	An end-user executes the Export to Image command.
ExportToExcel	An end-user executes the Export to Excel command.

Remarks

Use the ExportAction property to determine the export format or whether the dashboard is shown in the Print Preview form.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportAction property.

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#

winforms-dashboard-beforeexportdocument-event/CS/WinForms_Dashboard_BeforeExportEvent_Example/Form1.cs#L35

{
    if (e.ExportAction == DashboardExportAction.ExportToPdf &&
        e.PdfExportOptions.ExportFilters == false)

VB.NET

winforms-dashboard-beforeexportdocument-event/VB/WinForms_Dashboard_BeforeExportEvent_Example/Form1.vb#L32

Private Sub DashboardDesigner1_BeforeExportDocument(ByVal sender As Object, ByVal e As BeforeExportDocumentEventArgs)
    If e.ExportAction = DashboardExportAction.ExportToPdf AndAlso e.PdfExportOptions.ExportFilters = False Then
        e.HideItem(Function(item) TypeOf item Is FilterElementDashboardItem OrElse TypeOf item Is DateFilterDashboardItem)