Export Events
You can customize the files exported to Excel and CSV by using the OnBeforeExport and the OnAfterExport events exposed to the GridExcelExport and GridCsvExport tags.
In This Article
OnBeforeExport
The OnBeforeExport event fires after the user clicks the ExcelExport or CsvExport button and before the export process starts. You can use the event to configure the exported Grid columns or change the exported data. The event handler receives a GridBeforeExcelExportEventArgs and GridBeforeCsvExportEventArgs object, depending on the type of export, which provides the following properties:
For Excel Export
-
Columns—List<GridExcelExportColumn>—A collection of all exportable columns in the Grid. These are all visibleGridColumninstances. You can customize the following attributes of the Grid column before exporting it into Excel:Width—Define the width of the column in pixels.Title—Define the column title to be shown in the Excel file header.NumberFormat—Provide an Excel-compatible number/date formatField—Set the data bound field of the column.
To export a hidden Grid column that has its Visible parameter set to false, you can manually define an instance of the GridExcelExportColumn in the handler for the OnBeforeExport event and add that column to the args.Columns collection.
-
Data—IEnumerable<object>—Assign a custom collection of data to be exported to Excel, for example only the selected items in the Grid. -
isCancelled—bool—Cancel theOnBeforeExcelevent by setting theisCancelledproperty totrue.
Using the Grid OnBeforeExport with Excel export
For CSV Export
-
Data—IEnumerable<object>—Assign a custom collection of data to be exported to CSV, for example only the selected items in the Grid. -
Columns—List<GridCsvExportColumn>—A collection of all exportable columns in the Grid. These are all visibleGridColumninstances. You can customize the following attributes of the Grid column before exporting it into Excel:Title—Define the column title to be shown in the Excel file header.Field—Set the data bound field of the column.
To export a hidden Grid column that has its Visible parameter set to false, you can manually define an instance of the GridCsvExportColumn in the handler for the OnBeforeExport event and add that column to the args.Columns collection.
isCancelled—bool—Cancel theOnBeforeExcelevent by setting theisCancelledfield totrue.
For PDF Export
-
Columns—List<GridPdfExportColumn>—A collection of all exportable columns in the Grid. These are all visibleGridColumninstances. You can customize the following attributes of the Grid column before exporting it into PDF:Width—Define the width of the column in pixels.Title—Define the column title to be shown in the PDF file header.NumberFormat—Provide a PDF-compatible number/date format.Field—Set the data bound field of the column.
To export a hidden Grid column that has its Visible parameter set to false, you can manually define an instance of the GridPdfExportColumn in the handler for the OnBeforeExport event and add that column to the args.Columns collection.
-
Data—IEnumerable<object>—Assign a custom collection of data to be exported to PDF, for example only the selected items in the Grid. -
isCancelled—bool—Cancel theOnBeforeExcelevent by setting theisCancelledproperty totrue.
Using the Grid OnBeforeExport with PDF export
OnAfterExport
The OnAfterExport event fires after OnBeforeExport and before the generated file is provided to the user. You can use the event to make changes to the exported file. The event handler receives a GridAfterExcelExportEventArgs or GridAfterCsvExportEventArgs object, depending on the type of export, which provides the following fields:
For Excel Export
Stream—MemoryStream—The output of the Excel export as a memory stream. The stream itself is finalized, so that the resource does not leak. To read and work with the stream, clone its available binary data to a newMemoryStreaminstance.
Get the stream of the exported Excel file
For CSV Export
Stream—MemoryStream—The output of the CSV export as aMemoryStream. The stream itself is finalized, so that the resource does not leak. To read and work with the stream, clone its available binary data to a newMemoryStreaminstance.
Get the stream of the exported CSV file
For PDF Export
Stream—MemoryStream—The output of the PDF export as a memory stream. The stream itself is finalized, so that the resource does not leak. To read and work with the stream, clone its available binary data to a newMemoryStreaminstance.
Get the stream of the exported PDF file
See Also
- Grid Excel Export
- Grid CSV Export
- Grid PDF Export
- Custom cell formatting of the exported file with RadSpreadProcessing
- Custom cell formatting of the exported file with RadSpreadStreamProcessing
- Format numbers and dates in the exported CSV file from the Grid
- Change the default CSV delimiter (comma) during Grid export
- Blazor Grid