Blazor Grid Export

The Grid for Blazor provides a built-in functionality to export the data to:

• CSV
• Excel
• PDF

Before proceeding to the dedicated export articles, ensure you are familiar with the following information:

How the Export Works

The Grid export feature has the following specifics:

• If the Grid is using OnRead and is exporting all pages, it will fire an additional OnRead event at the time of exporting, with a request PageSize of 0. This will enable the component to obtain all data.
• The time for export will be longer if:
  • The Grid has a lot of records.
  • The Grid is in a WebAssembly app where all the code runs in the browser and in one thread.

While the file is being generated, the UI will be unresponsive, so you may want to show a loading sign to the user during the export process.

Requirements

In server-side Blazor apps, the file may become larger than the default SignalR message size limit. This can disconnect the client and result in an error. You may need to increase the maximum SignalR message size.

Limitations

The Grid export feature has the following limitations:

• Templates are not exported, because there is no provision in the framework for getting RenderFragment content at runtime. Thus, column, header or group header/footer templates are ignored. The headers in the exported file match the Title of the column. The exported values match the data from the column Field. If you need additional information, see if you can add it to a property in the model, or create your own file. Find a project example on how to generate your own exported file. Find additional information on how to export an image that is rendered in a Grid column template.
• bool fields are exported as TRUE or FALSE strings, because there is no native boolean data type in the exported formats and these string values are the most common ones used in data and macros.
• Dates are exported in the following format: mm/dd/yyyy hh:mm:ss plus the current app culture AM/PM specifier. The Excel date formats are different than .NET date formats and Excel may not always recognize the column as dates, for example, if the entire date format from the .NET culture is used. To customize the date formats, use the Export Events.
• Numbers are exported in the following format which uses the current thread culture: Convert.ToDouble(value). To customize the number formats use the Export Events.
• The Grid exports only <GridColumn> instances. Other types of columns are not exported (for example: command, checkbox, hierarchy, group and row-drag columns).

Customization

The Grid allows customization of the exported files. You can determine the desired data to be exported, change the number and date formats, and more. For such customizations, handle the export events.

See Also

• Grid Export to CSV
• Grid Export to Excel
• Grid Export to PDF
• Live Demo: Grid Export