'Declaration Public Event SynchronousExportError As EventHandler(Of SynchronousExportErrorEventArgs)
public event EventHandler<SynchronousExportErrorEventArgs> SynchronousExportError
The event handler receives an argument of type SynchronousExportErrorEventArgs containing data related to this event. The following SynchronousExportErrorEventArgs properties provide information specific to this event.
| Property | Description |
|---|---|
| DisplayErrorMessage (Inherited from Infragistics.Win.UltraWinGrid.ExcelExport.ExportErrorEventArgs) | Gets or sets whether an error dialog will be displayed by the UltraGridExcelExporter. |
| Exception (Inherited from Infragistics.Win.UltraWinGrid.ExcelExport.ExportErrorEventArgs) | The exception that occurred during the export process, or null if the error was not caused by an exception. |
| ThrowException | Gets or sets whether the exception will be rethrown after the event fires. The default is true, which preserves backward compatibility. Set to false to suppress the exception and allow the application to continue. |
| Workbook (Inherited from Infragistics.Win.UltraWinGrid.ExcelExport.ExportErrorEventArgs) | Exporting workbook. |
This event fires when an error or exception occurs during a synchronous export operation. For example, if you attempt to export to a file and the file is locked and cannot be overwritten, or if an error occurs during row or cell processing.
By default, the exception will be rethrown after this event fires, preserving existing behavior. Setting SynchronousExportErrorEventArgs.ThrowException to false will suppress the exception and allow the application to continue.
Setting SynchronousExportErrorEventArgs.DisplayErrorMessage to true will cause the UltraGridExcelExporter to display an error dialog. This is false by default for synchronous exports.
Regardless of whether the exception is rethrown, cleanup is always performed so that subsequent export operations can proceed normally.
Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2