DxTreeList.ExportToXlsAsync(String, TreeListXlExportOptions) Method

Exports TreeList data in XLS format and downloads the resulting file to the client machine.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v25.1.dll

NuGet Package: DevExpress.Blazor

Declaration

public Task ExportToXlsAsync(
    string fileName,
    TreeListXlExportOptions options = null
)

Parameters

Name	Type	Description
fileName	String	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 (ExportToXlsAsync(Stream, TreeListXlExportOptions)) or to a file downloaded to a client machine (the current overload).

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 Blazor TreeList Data to XLS/XLSX.

Run Demo: TreeList - Export

Example

The following example exports TreeList data to XLS format on a button click:

<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() {
        await MyTreeList.ExportToXlsAsync("ExportResult");
    }
}

Export Specifics and Limitations

• Content of templates is not exported.
• Excel permits up to seven nesting levels in outlines. Deeper nesting levels are exported at the seventh nesting level.
• The TreeList exports custom summaries (implemented in the CustomSummary event) as plain text.
• Data columns anchored to the right edge become regular columns, while columns anchored to the component’s left edge remain frozen.
• CSS classes applied to the TreeList and its elements do not affect the exported document’s appearance. Handle the CustomizeCell event to customize the output table.
• In on demand data loading mode, an export operation forces the component to load all data.

If the TreeList is bound to a GridDevExtremeDataSource object, the following limitations apply:

• Filtering and sorting may differ in the resulting document because export depends on database collation.
• You must specify the KeyFieldName property to export only selected rows.

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

• Excel specifications and limits
• Exporting to Microsoft Excel

Implements

ExportToXlsAsync(String, TreeListXlExportOptions)