SpreadsheetControl.UnhandledException Event

This event is raised when an exception unhandled by the SpreadsheetControl occurs.

Namespace: DevExpress.Xpf.Spreadsheet

Assembly: DevExpress.Xpf.Spreadsheet.v24.2.dll

NuGet Package: DevExpress.Wpf.Spreadsheet

Declaration

C#

public event UnhandledExceptionEventHandler UnhandledException

VB.NET

Public Event UnhandledException As UnhandledExceptionEventHandler

Event Data

The UnhandledException event's data class is SpreadsheetUnhandledExceptionEventArgs. The following properties provide information specific to this event:

Property	Description
Exception	Gets the exception which triggers the UnhandledException event.
Handled	Gets or sets whether the exception should be propagated upwards.

Remarks

The UnhandledException event is helpful when a command is executed via the Bar (Ribbon) user interface, and you are unable to catch the exception which is likely to occur. The most common case is an attempt to save the document to a read-only or locked file. If you do not handle the UnhandledException event, the unhandled exception is thrown and the application crashes. All changes in the document are lost. To prevent this, handle the exception using the following code.

C#

private void spreadsheetControl1_UnhandledException(object sender, 
    DevExpress.XtraSpreadsheet.SpreadsheetUnhandledExceptionEventArgs e)
{
    e.Handled = true;
    // Add your code to handle the exception.
    BeginInvoke(new MethodInvoker(delegate()
    {
        MessageBox.Show(e.Exception.Message, "The command is not completed!");
    }));
}

VB.NET

Private Shared My_Exception As Exception

Private Sub spreadsheetControl1_UnhandledException(ByVal sender As Object,  _
        ByVal e As DevExpress.XtraSpreadsheet.SpreadsheetUnhandledExceptionEventArgs)  _
        Handles spreadsheetControl1.UnhandledException
    My_Exception = e.Exception
    e.Handled = True
    ' Add your code to handle the exception.
    BeginInvoke(New MethodInvoker(AddressOf ShowMessageMethod))
End Sub
Private Shared Sub ShowMessageMethod()
    MessageBox.Show(My_Exception.Message, "The command is not completed!")
End Sub

Related GitHub Examples

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

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.

XAML

wpf-spreadsheet-create-custom-progress-indicator/CS/WpfSpreadsheetProgressSample/MainWindow.xaml#L20

                              ShowStatusBar="True"
                              UnhandledException="spreadsheetControl1_UnhandledException"/>
</Grid>