Controls / Grid / Functionality / Exporting

New to Telerik UI for ASP.NET AJAX? Download free 30-day trial

CSV Export

CSV format is based on plain text - it is widely used to display simple tabular data. Due to its simplicity and portability, it can be seen in various platforms - web, desktop, mobile, embedded, etc.

By default, RadGrid's CSV engine encloses all the data within double quotes to allow the usage of commas, new lines and so on.

  • Depending on your local settings, the default column separator might be a comma or a semicolon . Excel won't be able to properly separate the columns when the column separator is not valid for the current culture.
  • If you set ExportOnlyData="true", the contents (text) of all template columns will be removed but the columns will be still visible in the exported file. To handle Template Columns, check out the Export GridTemplateColumn Content section.

Usage

To export the Grid to CSV, you can either use the built-in Buttons or call the the dedicated Grid methods. For more details, please visit the Enable the Export Buttons and Export using the Grid's APIs articles.

Export Events

Server-Side events triggered for the CSV format.

  • OnGridExporting: This event is triggered when the Grid is exporting. It can be used to access the output from the event argument (string) e.ExportOutput, See OnGridExporting Event

Customizing the Export Output

CSV specific settings

RadGrid exposes the following properties for customizing the output:

Name Options Description
ColumnDelimiter Colon, Comma, NewLine, Semicolon, Tab, VerticalBar Used to specify the column delimiter
RowDelimiter Colon, Comma, NewLine, Semicolon, Tab, VerticalBar Used to specify the row delimiter
FileExtension File extension string Useful when the developer wishes to change the file extension. Since the CSV format is text-based, it is often saved as TXT instead of CSV
EncloseDataWithQuotes True/False Determines whether the exported values are enclosed with quotes.

Example

<ExportSettings>    
    <Csv ColumnDelimiter="Tab" RowDelimiter="NewLine" FileExtension="TXT" EncloseDataWithQuotes="true" />
</ExportSettings>

Microsoft Excel parses the cell values automatically depending on the local settings. For example the string 19/05 might change to 19.May automatically. The only workaround would be to insert a sign of equality ( = ) before the relevant string. For example: "012" should be modified as ="012" .

Encoding support

UI for ASP.NET AJAX Q2 2009 SP1 and later fully supports Unicode symbols in both left-to-right and right-to-left modes. RadGrid automatically saves the file in UTF-8 encoding.

If you open the CSV file in some editors, you will notice some strange characters at the beginning. This is the BOM (Byte Order Mark) header - it marks the file content as Unicode. These characters wouldn't be visible under normal circumstances.

Since UI for ASP.NET AJAX Q3 2014 SP1 version, you are able to change the default encoding of the CSV format. The property that allows you to change the encoding is named Encoding and has the following predefined values.

  • Utf8 (default)
  • Ascii (US ASCII)
  • Default (system default (ANSI); depends on the regional settings of the OS)
  • Windows1252 (Western European encoding)
  • Unicode (UTF16 little endian)
  • Utf7
  • Utf32 (UTF32 little endian)

Along with Encoding property we introduce a possibility to disable the BOM (Byte Order Mark) header by setting EnableBomHeader. This property is of type boolean and accepts True (Default) and False values. You can find more information about BOM header in the following article.

<telerik:RadGrid RenderMode="Lightweight" ID="RadGrid1" runat="server">
    <MasterTableView CommandItemDisplay="Top">
        <CommandItemSettings ShowExportToCsvButton="true" />
    </MasterTableView>
    <ExportSettings>
        <Csv EnableBomHeader="true" Encoding="Unicode" />
    </ExportSettings>
</telerik:RadGrid>

Exporting the selected rows only

You can hide the unselected rows and export the rest in a manner similar to the example above. This approach is applicable also for HTML Excel/Word and PDF.

protected void Button1_Click(object sender, EventArgs e)
{
    foreach (GridDataItem item in RadGrid1.MasterTableView.Items)
        item.Visible = item.Selected;
    RadGrid1.MasterTableView.ExportToCSV();
}

Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles Button1.Click
    For Each item As GridDataItem In RadGrid1.MasterTableView.Items
        item.Visible = item.Selected
    Next RadGrid1.MasterTableView.ExportToCSV()
End Sub

Export GridTemplateColumn Content

Since CSV is text-based format it doesn't support images or complex structures like tables.It is possible to replace such content manually by removing the unwanted objects before exporting or on ItemDataBound/ItemCreated events:

GridTemplateColumn definition

<telerik:GridTemplateColumn UniqueName="MyColumn" HeaderText="MyColumn">
    <ItemTemplate>
        <asp:Image ID="Image1" runat="server" ImageUrl="~/img.png" AlternateText="AltText" />
    </ItemTemplate>
</telerik:GridTemplateColumn>

Backend code

protected void Button1_Click(object sender, EventArgs e)
{
    foreach (GridDataItem item in RadGrid1.MasterTableView.Items)
    {
        Image img = item["MyColumn"].FindControl("Image1") as Image;
        item["MyColumn"].Text = img.AlternateText;
    }
    RadGrid1.MasterTableView.ExportToCSV();
}

Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles Button1.Click
    For Each item As GridDataItem In RadGrid1.MasterTableView.Items
        Dim img As Image = TryCast(item("MyColumn").FindControl("Image1"), Image)
        item("MyColumn").Text = img.AlternateText
    Next
    RadGrid1.MasterTableView.ExportToCSV()
End Sub

This approach won't work if your RadGrid rebinds before export. For instance, if using the IgnorePaging="true", the Grid rebinds before the export, so the the developer should put the code inside the ItemCreated/ItemDataBound events.

For Telerik UI for ASP.NET AJAX version Q3 2015 and later there is property named IsExporting for the Grid that can be used to understand whether the Grid is exporting.

Example

// ItemCreated Event
protected void RadGrid1_ItemCreated(object sender, GridItemEventArgs e)
{
    RadGrid grid = (RadGrid)sender; 

    if (e.Item is GridDataItem && grid.IsExporting)
    {
        TableCell cell = ((GridDataItem)e.Item)["myColumn"];
        Image img = (Image)ell.FindControl("Image1");
        cell.Text = img.AlternateText;
    }
}
// ItemDataBound Event
protected void RadGrid1_ItemDataBound(object sender, GridItemEventArgs e)
{
    RadGrid grid = (RadGrid)sender; 

    if (e.Item is GridDataItem && grid.IsExporting)
    {
        TableCell cell = ((GridDataItem)e.Item)["myColumn"];
        Image img = (Image)ell.FindControl("Image1");
        cell.Text = img.AlternateText;
    }
}

'ItemCreated Event
Protected Sub RadGrid1_ItemCreated(ByVal sender As Object, ByVal e As GridItemEventArgs)
    Dim grid As RadGrid = CType(sender, RadGrid)

    If TypeOf e.Item Is GridDataItem AndAlso grid.IsExporting Then
        Dim cell As TableCell = CType(e.Item, GridDataItem)("myColumn")
        Dim img As Image = CType(cell.FindControl("Image1"), Image)
        cell.Text = img.AlternateText
    End If
End Sub
'ItemDataBound Event
Protected Sub RadGrid1_ItemDataBound(ByVal sender As Object, ByVal e As GridItemEventArgs)
    Dim grid As RadGrid = CType(sender, RadGrid)

    If TypeOf e.Item Is GridDataItem AndAlso grid.IsExporting Then
        Dim cell As TableCell = CType(e.Item, GridDataItem)("myColumn")
        Dim img As Image = CType(cell.FindControl("Image1"), Image)
        cell.Text = img.AlternateText
    End If
End Sub

For Telerik UI for ASP.NET AJAX version earlier than Q3 2015, you will need to use a boolean Flag.

Example

bool isExport = false;
protected void Button1_Click(object sender, EventArgs e)
{
    isExport = true;
    RadGrid1.MasterTableView.ExportToCSV();
}
// ItemCreated Event
protected void RadGrid1_ItemCreated(object sender, GridItemEventArgs e)
{
    if (e.Item is GridDataItem && isExport)
    {
        TableCell cell = ((GridDataItem)e.Item)["myColumn"];
        Image img = (Image)ell.FindControl("Image1");
        cell.Text = img.AlternateText;
    }
}
// ItemDataBound Event
protected void RadGrid1_ItemDataBound(object sender, GridItemEventArgs e)
{
    if (e.Item is GridDataItem && isExport)
    {
        TableCell cell = ((GridDataItem)e.Item)["myColumn"];
        Image img = (Image)ell.FindControl("Image1");
        cell.Text = img.AlternateText;
    }
}

Private isExport As Boolean = FalseProtected
Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles Button1.Click
    isExport = True
    RadGrid1.MasterTableView.ExportToCSV()
End Sub
'ItemCreated Event
Protected Sub RadGrid1_ItemCreated(ByVal sender As Object, ByVal e As GridItemEventArgs) Handles RadGrid1.ItemCreated
    If TypeOf e.Item Is GridDataItem AndAlso isExport Then
        Dim cell As TableCell = CType(e.Item, GridDataItem)("myColumn")
        Dim img As Image = CType(cell.FindControl("Image1"), Image)
        cell.Text = img.AlternateText
    End If
End Sub
'ItemDataBound Event
Protected Sub RadGrid1_ItemCreated(ByVal sender As Object, ByVal e As GridItemEventArgs) Handles RadGrid1.ItemCreated
    If TypeOf e.Item Is GridDataItem AndAlso isExport Then
        Dim cell As TableCell = CType(e.Item, GridDataItem)("myColumn")
        Dim img As Image = CType(cell.FindControl("Image1"), Image)
        cell.Text = img.AlternateText
    End If
End Sub

Hiding Columns from Exported File

You can use the HideStructureColumns property to hide GridRowIndicatorColumn, GridExpandColumn and GridGroupSplitterColumn. For the other columns types,you can use the following approach:

protected void Button1_Click(object sender, EventArgs e)
{
    RadGrid1.MasterTableView.GetColumn("C2").Visible = false;
    RadGrid1.MasterTableView.ExportToCSV();
}

Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles Button1.Click
    RadGrid1.MasterTableView.GetColumn("C2").Visible = False
    RadGrid1.MasterTableView.ExportToCSV()
End Sub

From Q2 2013 we introduced a new property named Exportable. This property allows you to choose whether a certain column should be included in the exported file or not. By setting this property to false the related column will be excluded from the exported file. Its default value is true.

Hiding Rows from Exported File

There are two common ways to hide an item.

Directly - in the button handler when exporting from a button or on ItemCommand when exporting from the built-in buttons

Hiding Items in the ItemCommand event

protected void RadGrid1_ItemCommand(object source, GridCommandEventArgs e)
{
    if (e.CommandName == RadGrid.ExportToCsvCommandName)
        RadGrid1.MasterTableView.Items[2].Visible = false;
}

Protected Sub RadGrid1_ItemCommand(ByVal source As Object, ByVal e As GridCommandEventArgs) Handles RadGrid1.ItemCommand
    If e.CommandName = RadGrid.ExportToCsvCommandName Then
        RadGrid1.MasterTableView.Items(2).Visible = False
    End If
End Sub

Hiding Items On Button Click

protected void Button1_Click(object sender, EventArgs e)
{
    RadGrid1.MasterTableView.Items[2].Visible = false;
    RadGrid1.MasterTableView.ExportToCSV();
}

Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles Button1.Click
    RadGrid1.MasterTableView.Items(2).Visible = False
    RadGrid1.MasterTableView.ExportToCSV()
End Sub

On ItemCreated / ItemDataBound - this approach should be used when IgnorePaging="true" or when you call RadGrid.Rebind before exporting.

For Telerik UI for ASP.NET AJAX version Q3 2015 and later there is property named IsExporting for the Grid that can be used to understand whether the Grid is exporting.

Example

protected void RadGrid1_ItemCreated(object sender, GridItemEventArgs e)
{
    if (RadGrid1.IsExporting && e.Item.ItemIndex == 2)
        e.Item.Display = false;
}
protected void RadGrid1_ItemDataBound(object sender, GridItemEventArgs e)
{
    if (RadGrid1.IsExporting && e.Item.ItemIndex == 2)
        e.Item.Display = false;
}

Protected Sub RadGrid1_ItemCreated(ByVal sender As Object, ByVal e As GridItemEventArgs)
    If RadGrid1.IsExporting AndAlso e.Item.ItemIndex = 2 Then
        e.Item.Display = False
    End If
End Sub
Protected Sub RadGrid1_ItemDataBound(ByVal sender As Object, ByVal e As GridItemEventArgs)
    If RadGrid1.IsExporting AndAlso e.Item.ItemIndex = 2 Then
        e.Item.Display = False
    End If
End Sub

For Telerik UI for ASP.NET AJAX version earlier than Q3 2015, you will need to use a boolean Flag.

Example

bool isCsvExport = false; // boolean Flag
protected void RadGrid1_ItemCommand(object source, GridCommandEventArgs e)
{
    if (e.CommandName == RadGrid.ExportToCsvCommandName)
        isCsvExport = true;
}
protected void RadGrid1_ItemCreated(object sender, GridItemEventArgs e)
{
    if (isCsvExport && e.Item.ItemIndex == 2)
        e.Item.Display = false;
}
protected void RadGrid1_ItemDataBound(object sender, GridItemEventArgs e)
{
    if (isCsvExport && e.Item.ItemIndex == 2)
        e.Item.Display = false;
}

Private isCsvExport As Boolean = False 'boolean Flag
Protected Sub RadGrid1_ItemCommand(ByVal source As Object, ByVal e As GridCommandEventArgs)

    If e.CommandName = RadGrid.ExportToCsvCommandName Then
        isCsvExport = True
    End If
End Sub
Protected Sub RadGrid1_ItemCreated(ByVal sender As Object, ByVal e As GridItemEventArgs)
    If isCsvExport AndAlso e.Item.ItemIndex = 2 Then
        e.Item.Display = False
    End If
End Sub
Protected Sub RadGrid1_ItemDataBound(ByVal sender As Object, ByVal e As GridItemEventArgs)
    If isCsvExport AndAlso e.Item.ItemIndex = 2 Then
        e.Item.Display = False
    End If
End Sub

CSV Export Q & A

  • Q: Can I export content from GridTemplateColumn?
  • A: Yes, as long as it contain a binding expression or regular Label control and ExportOnlyData is set to "false".
  • Q: How to export GridCheckBoxColumn?
  • A: You have to set ExportOnlyData to "false"

Limitations

The following features are not supported when exporting using the CSV Format:

  • Hierarchical structure
  • Grouping
  • Exporting invisible RadGrid (Visible="False")
  • Exporting anything other than Text. Instead, export the text that is related to the Control such as Text, Value, AlternateText, etc. See Export GridTemplateColumn Content for an example.
In this article
Related articles
Not finding the help you need? Improve this article