New to Telerik UI for Blazor? Start a free 30-day trial

Grid CSV Export

You can export the grid to CSV with a click of a button. The current filter, sort, page, grouping and column order are applied to the .csv document.

When you click the Export button, your browser will receive the resulting file.

Make sure to get familiar with all the general export documentation first.

Basics

To enable the CSV export in the Grid:

Add the Export Tool
Configure the Export Settings

Add the Export Tool

Add the GridToolBarCsvExportTool inside the <GridToolBar>:

RAZOR

<GridToolBar>        
    <GridToolBarCsvExportTool>
        Export to CSV
    </GridToolBarCsvExportTool>
</GridToolBar>

If you have a custom Toolbar, add a command button with the CsvExport command name inside a templated Grid Toolbar(<GridToolBarTemplate>).

Configure the Export Settings

To configure the CSV export settings, add the GridCsvExport tag under the GridExport tag. You may set the following options:

Parameter	Type and Default Value	Description
`FileName`	`string`	The name of the file. The grid will add the `.csv` extension for you.
`AllPages`	`bool`	Whether to export the current page only, or the entire data from the data source.

For further customizations, use the GridExcelExport tag to subscribe to the Grid export events.

Export the Grid to CSV

@* You can sort, group, filter, page the grid, reorder its columns, and you can click the
    Export button to save the current data *@

<TelerikGrid Data="@GridData"
             Pageable="true"
             Sortable="true"
             Reorderable="true"
             FilterMode="@GridFilterMode.FilterRow"
             Groupable="true">

    <GridToolBar>
        <GridToolBarCsvExportTool>
            Export to CSV
        </GridToolBarCsvExportTool>
    </GridToolBar>

    <GridExport>
        <GridCsvExport FileName="telerik-grid-export" />
    </GridExport>

    <GridColumns>
        <GridColumn Field="@nameof(SampleData.ProductId)" Title="ID" />
        <GridColumn Field="@nameof(SampleData.ProductName)" Title="Product Name" />
        <GridColumn Field="@nameof(SampleData.UnitsInStock)" Title="In stock" />
        <GridColumn Field="@nameof(SampleData.Price)" Title="Unit Price" />
        <GridColumn Field="@nameof(SampleData.Discontinued)" Title="Discontinued" />
        <GridColumn Field="@nameof(SampleData.FirstReleaseDate)" Title="Release Date" />
    </GridColumns>
</TelerikGrid>

@code {
    private List<SampleData> GridData { get; set; }

    protected override void OnInitialized()
    {
        GridData = Enumerable.Range(1, 100).Select(x => new SampleData
            {
                ProductId = x,
                ProductName = $"Product {x}",
                UnitsInStock = x * 2,
                Price = 3.14159m * x,
                Discontinued = x % 4 == 0,
                FirstReleaseDate = DateTime.Now.AddDays(-x)
            }).ToList();
    }

    public class SampleData
    {
        public int ProductId { get; set; }
        public string ProductName { get; set; }
        public int UnitsInStock { get; set; }
        public decimal Price { get; set; }
        public bool Discontinued { get; set; }
        public DateTime FirstReleaseDate { get; set; }
    }
}

Programmatic Export

You can programmatically invoke the export feature of the Grid, by using the following methods exposed on the @ref of the Grid:

Method	Type	Description
`SaveAsCsvFileAsync`	`ValueTask`	Sends the exported CSV file to the browser for download.
`ExportToCsvAsync`	`Task<MemoryStream>`	Returns the exported data as a `MemoryStream`. 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 new `MemoryStream` instance.

The same methods are exposed for exporting an Excel file.

Invoke the export function from code

@* Send the exported file for download and get the exported data as a memory stream *@

@using System.IO

<TelerikButton OnClick="@(async () => await GridRef.SaveAsCsvFileAsync())">Download the CSV file</TelerikButton>
<TelerikButton OnClick="@GetTheDataAsAStream">Get the Exported Data as a MemoryStream</TelerikButton>

<TelerikGrid @ref="@GridRef"
             Data="@GridData"
             Pageable="true"
             Sortable="true"
             Reorderable="true"
             FilterMode="@GridFilterMode.FilterRow"
             Groupable="true">

    <GridToolBarTemplate>
        <GridCommandButton Command="CsvExport" Icon="@SvgIcon.FileCsv">Export to CSV</GridCommandButton>
        <label class="k-checkbox-label"><TelerikCheckBox @bind-Value="@ExportAllPages" />Export All Pages</label>
    </GridToolBarTemplate>

    <GridExport>
        <GridCsvExport FileName="telerik-grid-export" AllPages="@ExportAllPages" />
    </GridExport>

    <GridColumns>
        <GridColumn Field="@nameof(SampleData.ProductId)" Title="ID" />
        <GridColumn Field="@nameof(SampleData.ProductName)" Title="Product Name" />
        <GridColumn Field="@nameof(SampleData.UnitsInStock)" Title="In stock" />
        <GridColumn Field="@nameof(SampleData.Price)" Title="Unit Price" />
        <GridColumn Field="@nameof(SampleData.Discontinued)" Title="Discontinued" />
        <GridColumn Field="@nameof(SampleData.FirstReleaseDate)" Title="Release Date" />
    </GridColumns>
</TelerikGrid>

@code {
    private TelerikGrid<SampleData> GridRef { get; set; }

    private MemoryStream exportedCSVStream { get; set; }

    private List<SampleData> GridData { get; set; }

    private bool ExportAllPages { get; set; }

    private async Task GetTheDataAsAStream()
    {
        MemoryStream finalizedStream = await GridRef.ExportToCsvAsync();

        exportedCSVStream = new MemoryStream(finalizedStream.ToArray());
    }

    protected override void OnInitialized()
    {
        GridData = Enumerable.Range(1, 100).Select(x => new SampleData
            {
                ProductId = x,
                ProductName = $"Product {x}",
                UnitsInStock = x * 2,
                Price = 3.14159m * x,
                Discontinued = x % 4 == 0,
                FirstReleaseDate = DateTime.Now.AddDays(-x)
            }).ToList();
    }

    public class SampleData
    {
        public int ProductId { get; set; }
        public string ProductName { get; set; }
        public int UnitsInStock { get; set; }
        public decimal Price { get; set; }
        public bool Discontinued { get; set; }
        public DateTime FirstReleaseDate { get; set; }
    }
}

Customization

To customize the exported file, handle the OnBeforeExport or OnAfterExport events the Grid exposes.

The component allows you to control the data set that will be exported. It also provides built-in customization options for the columns, such as Width, Title, and more.

For more advanced customizations (such as formatting the numbers and dates, or changing the default comma delimiter) the Grid lets you get the MemoryStream of the file. Thus, you can customize it using the SpreadProcessing or the SpreadStreamProcessing libraries that are available with your license.