DxTreeList.ExportToXlsAsync(Stream, TreeListXlExportOptions) Method

Exports TreeList data in XLS format to a stream.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.2.dll

NuGet Package: DevExpress.Blazor

Declaration

public Task ExportToXlsAsync(
    Stream stream,
    TreeListXlExportOptions options = null
)

Parameters

Name	Type	Description
stream	Stream	The target stream for export.

Optional Parameters

Name	Type	Default	Description
options	TreeListXlExportOptions	null	An object that contains export options.

Returns

Type	Description
Task	The task that is completed when the file is exported.

Remarks

Call the ExportToXlsAsync method to export TreeList data in XLS format. The method overloads allow you to write the result to a stream (the current overload) or to a file downloaded to a client machine (ExportToXlsAsync(String, TreeListXlExportOptions)).

The method accepts a TreeListXlExportOptions object as a parameter. You can use this parameter to set up export settings.

For more information about data export in the TreeList component, refer to the following topic: Export Data in Blazor TreeList.

Run Demo: TreeList - Export

Example

The following example uses a file stream to export TreeList data to the XLSX file:

<DxButton Text="Export to XLS" Click="ExportXls_Click" />

<DxTreeList Data="TreeListData" 
            KeyFieldName="Id" 
            ParentKeyFieldName="ParentId" 
            @ref="MyTreeList">
    <Columns>
        <DxTreeListDataColumn FieldName="Name" Caption="Task" />
        <DxTreeListDataColumn FieldName="EmployeeName" />
        <DxTreeListDataColumn FieldName="StartDate" />
        <DxTreeListDataColumn FieldName="DueDate" />
    </Columns>
</DxTreeList>

@code {
    ITreeList MyTreeList { get; set; }

    async Task ExportXls_Click() {
        string path = @"C:\MyProjects\MyFile.xls";
        FileStream fs = File.OpenWrite(path);
        await MyTreeList.ExportToXlsAsync(fs);
        fs.Dispose();
    }
}

Export Specifics and Limitations

• Content of templates is not exported.
• Custom summaries implemented in the CustomSummary event are exported as plain text.
• Data columns anchored to the right edge become regular columns, while columns anchored to the components’s left edge remain frozen.
• The TreeList component filters and sorts selected rows on the client side. Filtering and sorting may differ in the resulting document because export depends on database collation.
• Appearance settings applied by style settings or in the CustomizeElement event handler are not exported. You can handle the CustomizeCell event to customize element appearance in the the exported document.
• Excel permits up to seven nesting levels in outlines. Deeper nesting levels are exported on the seventh nesting level.

Refer to the following articles for information about Microsoft Excel limitations:

• Excel specifications and limits
• Exporting to Microsoft Excel

Implements

ExportToXlsAsync(Stream, TreeListXlExportOptions)