Edit this page

ExportToXlsx

The ExportToXlsx method allows exporting to "Xlsx" format. As the mechanism uses RadSpreadProcessing internally, there is no need for the user to make the integration manually. The method was introduced in Q1 2015.

Assembly References

The ExportToXlsx method uses additional libraries so you need to add references to the following assemblies:

  • Telerik.Windows.Documents.Core.dll
  • Telerik.Windows.Documents.Spreadsheet.dll
  • Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml.dll
  • Telerik.Windows.Zip.dll
  • Telerik.Windows.Controls.GridView.Export.dll

Telerik.Windows.Controls.GridView.Export.dll is a new binary introduced in Q1 SP of 2015. It delimits the exporting to Xlsx functionality from Telerik.Windows.Controls.GridView.dll, so in order to use ExportToXlsx method, the new dll should also be added.

Method Overloads

  1. ExportToXlsx(Stream stream) - Expects the specified stream to which you are exporting data to.

  2. ExportToXlsx(Stream stream, GridViewDocumentExportOptions options) - Expects the specified stream to which you are exporting data to and parameter of type GridViewDocumentExportOptions. The latter is used to set the following export options:

  • Culture
  • Items
  • ShowColumnFooters
  • ShowGroupFooters
  • ShowColumnHeaders
  • ExportDefaultStyles
  • ExcludedColumns

The following example shows how to use the method on a button click:

Example 1: Use of ExportToXlsx Method

private void btnExport_Click(object sender, RoutedEventArgs e)
{
    string extension = "xlsx";

    SaveFileDialog dialog = new SaveFileDialog()
    {
        DefaultExt = extension,
        Filter = String.Format("{1} files (.{0})|.{0}|All files (.)|.", extension, "Excel"),
        FilterIndex = 1
    };

    if (dialog.ShowDialog() == true)
    {
        using (Stream stream = dialog.OpenFile())
        {
            gridViewExport.ExportToXlsx(stream,
                new GridViewDocumentExportOptions()
                {
                    ShowColumnFooters = true,
                    ShowColumnHeaders = true,
                    ShowGroupFooters = true
                });
        }
    }
}

Export Default Styles

To export the Default Styles of RadGridView in grouped state, at least one row must be expanded, so that the exporting engine can get the styles.

RadGridView can be exported with its default styles by setting the ExportDefaultStyles property to True

By default the ExportDefaultStyles property is set to false. You can see the result (Figure 1).

Figure 1: Exporting with ExportDefaultStyles set to “false” (default)

ExportDefaultStyles false

You can set the ExportDefaultStyles value to “true” and see the result (Figure 2).

Example 2: Configuring ExportDefaultStyles Setting

gridViewExport.ExportToXlsx(stream,
    new GridViewDocumentExportOptions()
        {
            ShowColumnHeaders = true,
            ShowColumnFooters = true,
            ShowGroupFooters = true,
            ExportDefaultStyles = true
        });   

Figure 2: Exporting with ExportDefaultStyles set to True

ExportDefaultStyles false

Disable Column Width Auto Fit

GridViewDocumentExportOptions expose the boolean AutoFitColumnsWidth property. Its default value is True, meaning that the column's width will be automatically fit based on its content. To disable this behavior, its value can be set to False.

Example 3: Setting the AutoFitColumnsWidth Property to False

if (dialog.ShowDialog() == true)
{
    using (Stream stream = dialog.OpenFile())
    {
        gridViewExport.ExportToXlsx(stream,
            new GridViewDocumentExportOptions()
            {
                ShowColumnHeaders = true,
                ShowColumnFooters = true,
                ShowGroupFooters = true,
                ExportDefaultStyles = true,
                AutoFitColumnsWidth = false
            });
    }
}

Figure 3: Exporting with AutoFitColumnsWidth set to False

AutoFitColumnsWidth false

Events

There are two events related to the exporting of RadGridView with the ExportToXlsx method: ElementExportingToDocument and ElementExportedToDocument. You can find more information regarding them in the Export Events section.

How to

See Also

Was this article helpful? Yes No

Give article feedback

Tell us how we can improve this article

Dummy