BaseView.PrintExportCompleted Event

Allows you to determine whether the view data was printed or exported without errors.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Data")]
public event PrintExportCompletedEventHandler PrintExportCompleted

VB.NET

<DXCategory("Data")>
Public Event PrintExportCompleted As PrintExportCompletedEventHandler

Event Data

The PrintExportCompleted event's data class is DevExpress.XtraGrid.Views.Base.PrintExportCompletedEventArgs.

Remarks

Use the event parameter’s e.Status property to determine whether the operation was successful (GridPrintExportResult.Success), failed (GridPrintExportResult.Error), or was cancelled (GridPrintExportResult.Cancel).

Example

The following example demonstrates how to display a message box if an error occurs while exporting or printing data in Server Mode:

C#

using DevExpress.XtraEditors;
using DevExpress.XtraGrid.Views.Base;

public Form1() {
    InitializeComponent();
    gridView1.PrintExportCompleted += GridView1_PrintExportCompleted;
}
private void GridView1_PrintExportCompleted(object sender, PrintExportCompletedEventArgs e) {
    if(e.Status == GridPrintExportResult.Error)
        XtraMessageBox.Show(
            new XtraMessageBoxArgs() {
                Text = "An unexpected error occurred while exporting data.",
                Caption = "Error",
                ImageOptions = new MessageBoxImageOptions() {
                    SvgImage = svgImageCollection1[0],
                    SvgImageSize = new Size(32, 32)
                }
            });
}

VB.NET

Imports DevExpress.XtraEditors
Imports DevExpress.XtraGrid.Views.Base

Public Sub New()
    InitializeComponent()
    AddHandler gridView1.PrintExportCompleted, AddressOf GridView1_PrintExportCompleted
End Sub
Private Sub GridView1_PrintExportCompleted(ByVal sender As Object, ByVal e As PrintExportCompletedEventArgs)
    If e.Status = GridPrintExportResult.Error Then
        XtraMessageBox.Show(New XtraMessageBoxArgs() With {
            .Text = "An unexpected error occurred while exporting data.", .Caption = "Error", .ImageOptions = New MessageBoxImageOptions() With {.SvgImage = svgImageCollection1(0), .SvgImageSize = New Size(32, 32)}
        })
    End If
End Sub