ExportToWorkbook

In R1 2016 we introduced a new extension method related to the exporting of RadGridView - ExportToWorkbook(). You can use it if you need to modify the content of the exported RadGridView and avoid styling the document manually.

Assembly References

ExportToWorkbook uses additional libraries so you need to add references to the following assemblies:

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

Usage

This method exports the associated RadGridView to a Workbook object. Examples 1 and 2 show how you can modify that object before exporting.

Example 1: Export RadGridView to a Workbook and modify cell style:

  private void Button_Click(object sender, RoutedEventArgs e) 
    { 
        //Instantiate the Workbook object 
        Workbook workbook = this.clubsGrid.ExportToWorkbook(); 
 
        //Modify the created Workbook 
        CellStyle wbStyle = workbook.Styles["Normal"]; 
        wbStyle.ForeColor = new ThemableColor(Colors.Green); 
        wbStyle.FontFamily = new ThemableFontFamily(ThemeFontType.Major); 
        wbStyle.FontSize = UnitHelper.PointToDip(16); 
        wbStyle.VerticalAlignment = RadVerticalAlignment.Top; 
 
        //Export the Workbook to an Excel file 
        SaveFileDialog dialog = new SaveFileDialog(); 
        dialog.DefaultExt = ".xlsx"; 
        dialog.Filter = String.Format("{1} files (.{0})|.{0}|All files (.)|.*", "xlsx", "Excel"); 
        dialog.FilterIndex = 1; 
 
        if (dialog.ShowDialog() == true) 
        { 
            var provider = new XlsxFormatProvider(); 
            using (var output = dialog.OpenFile()) 
            { 
                provider.Export(workbook, output); 
            } 
        } 
    } 

Example 2: Double the width of the exported columns:

for (int i = 0; i < workbook.ActiveWorksheet.UsedCellRange.ColumnCount; i++) 
{ 
    workbook.ActiveWorksheet.Columns[i].SetWidth(new ColumnWidth(this.clubsGrid.Columns[i].ActualWidth * 2, true)); 
} 

GridViewDocumentExportOptions

The method can be overloaded and take GridViewDocumentExportOptions as a parameter. You can use it to set the following export options:

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

The ExportToWorkbook method utilizes the SpreadProcessing library. You can check the respective documentation for more information on how to use the library.

See Also

In this article
Not finding the help you need? Improve this article