TreeListView.ExportToXlsx(String, XlsxExportOptions) Method

Exports a grid to the specified file path in XLSX format, using the specified XLSX-specific options.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v24.1.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public override void ExportToXlsx(
    string filePath,
    XlsxExportOptions options
)

VB.NET

Public Overrides Sub ExportToXlsx(
    filePath As String,
    options As XlsxExportOptions
)

Parameters

Name	Type	Description
filePath	String	A String which specifies the file name (including the full path) for the created XLSX file.
options	XlsxExportOptions	A XlsxExportOptions object which specifies the XLSX export options to be applied when a grid is exported.

Remarks

To display the Print Preview of the grid, use the DataViewBase.ShowPrintPreview and DataViewBase.ShowPrintPreviewDialog methods. To print the grid, use the DataViewBase.Print or DataViewBase.PrintDirect method.

To learn more, see Printing.

Note

The grid can be previewed, printed and exported only if the DXPrinting Library is available. You should manually add the reference to the DevExpress.Xpf.Printing.v24.1 assembly.

Example

This example shows how to preview, print, and export the GridControl‘s content.

View Example

XAML

<Grid>
    <Grid.RowDefinitions>
        <RowDefinition Height="*"/>
        <RowDefinition Height="Auto"/>
    </Grid.RowDefinitions>
    <dxg:GridControl x:Name="grid" AutoGenerateColumns="AddNew">
        <dxg:GridControl.View>
            <dxg:TableView x:Name="view" AutoWidth="True"/>
        </dxg:GridControl.View>
    </dxg:GridControl>
    <WrapPanel Grid.Row="1" Orientation="Horizontal">
        <Button Click="PreviewGrid" Content="Show Print Preview"/>
        <Button Click="ExportToXls" Content="Export to Excel"/>
        <Button Click="ExportToCsv" Content="Export to CSV"/>
        <Button Click="ExportToPng" Content="Export to an image"/>
    </WrapPanel>
</Grid>

C#

void PreviewGrid(object sender, RoutedEventArgs e) {
    view.ShowPrintPreviewDialog(this);
}
void ExportToXls(object sender, RoutedEventArgs e) {
    view.ExportToXlsx(@"d:\grid_export.xlsx");
}
void ExportToCsv(object sender, RoutedEventArgs e) {
    view.ExportToCsv(@"d:\grid_export.csv");
}
void ExportToPng(object sender, RoutedEventArgs e) {
    view.ExportToImage(@"d:\grid_export.png");
}

VB.NET

Private Sub PreviewGrid(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Me.view.ShowPrintPreviewDialog(Me)
End Sub

Private Sub ExportToXls(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Me.view.ExportToXlsx("d:\grid_export.xlsx")
End Sub

Private Sub ExportToCsv(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Me.view.ExportToCsv("d:\grid_export.csv")
End Sub

Private Sub ExportToPng(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Me.view.ExportToImage("d:\grid_export.png")
End Sub