DashboardExportAction Enum

Lists values that specify the export action performed by an end-user.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public enum DashboardExportAction

VB.NET

Public Enum DashboardExportAction

Members

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.

Related API Members

The following properties accept/return DashboardExportAction values:

• BeforeExportDocumentEventArgs.ExportAction
• BeforeExportDocumentWebEventArgs.ExportAction
• CustomExportBaseEventArgs.ExportAction
• CustomExportBaseWebEventArgs.ExportAction

Remarks

Values listed by this enumeration returned by the CustomExportBaseEventArgs.ExportAction and CustomExportBaseWebEventArgs.ExportAction event parameters.

Related GitHub Examples

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

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#

web-dashboard-how-to-add-custom-information-to-the-exported-excel-document-t504794/CS/WebDashboardForm.aspx.cs#L21

{
    if (e.ExportAction == DashboardExportAction.ExportToExcel)
    {

web-dashboard-custom-info-exported-excel/CS/WebDashboardForm.aspx.cs#L18

protected void ASPxWebDashboard1_CustomizeExportDocument(object sender, CustomizeExportDocumentWebEventArgs e) {
    if (e.ExportAction == DashboardExportAction.ExportToExcel) {
        MemoryStream ms = new MemoryStream();

WinForms-DashboardDesigner-CustomizeExportDocument-example/CS/CustomExportDocumentExample/Form1.cs#L29

{
    if (e.ExportAction == DashboardExportAction.ExportToExcel)
    {

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

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

VB.NET

web-dashboard-how-to-add-custom-information-to-the-exported-excel-document-t504794/VB/WebDashboardForm.aspx.vb#L19

Protected Sub ASPxWebDashboard1_CustomizeExportDocument(ByVal sender As Object, ByVal e As CustomizeExportDocumentWebEventArgs)
    If e.ExportAction = DashboardExportAction.ExportToExcel Then
        Dim ms As New MemoryStream()

web-dashboard-custom-info-exported-excel/VB/WebDashboardForm.aspx.vb#L21

Protected Sub ASPxWebDashboard1_CustomizeExportDocument(ByVal sender As Object, ByVal e As CustomizeExportDocumentWebEventArgs)
    If e.ExportAction = DashboardExportAction.ExportToExcel Then
        Dim ms As MemoryStream = New MemoryStream()

WinForms-DashboardDesigner-CustomizeExportDocument-example/VB/CustomExportDocumentExample/Form1.vb#L27

Private Sub dashboardDesigner1_CustomizeExportDocument(ByVal sender As Object, ByVal e As DevExpress.DashboardCommon.CustomizeExportDocumentEventArgs) Handles dashboardDesigner1.CustomizeExportDocument
    If e.ExportAction = DashboardExportAction.ExportToExcel Then
        Dim fileStream As FileStream = TryCast(e.Stream, FileStream)

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)