TreeListXlExportOptions Class

Contains options that define how a document is exported to XLS and XLSX files.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v25.1.dll

NuGet Package: DevExpress.Blazor

Declaration

public class TreeListXlExportOptions :
    TreeListExportOptions,
    IGridXlExportOptions

Remarks

When you export a grid in Microsoft Excel formats (the ExportToXlsAsync or ExportToXlsxAsync method), the GridXlExportOptions object allows you to customize the settings of the exported grid and the output file.

<DxTreeList @ref="TreeList"
            Data="TreeListData"
            ChildrenFieldName="Satellites"
            CssClass="max-h-480">
    <Columns>
        <DxTreeListDataColumn FieldName="Name" ExportWidth="240"/>
        <DxTreeListDataColumn FieldName="TypeOfObject" Caption="Type" FilterRowOperatorType="TreeListFilterRowOperatorType.Equal" ExportWidth="160">
            <EditSettings>
                <DxComboBoxSettings Data="TreeListRenderHelper.SpaceObjectTypes" SearchMode="@ListSearchMode.AutoSearch"
                                    SearchFilterCondition="@ListSearchFilterCondition.Contains" />
            </EditSettings>
        </DxTreeListDataColumn>
        <DxTreeListDataColumn FieldName="Mass10pow21kg" Caption="Mass, kg" DisplayFormat="N2">
            <HeaderCaptionTemplate>Mass, 10<sup>21</sup> &#215; kg</HeaderCaptionTemplate>
        </DxTreeListDataColumn>
        <DxTreeListDataColumn FieldName="MeanRadiusInKM" Caption="Radius, km" DisplayFormat="N2" ExportWidth="180"/>
        <DxTreeListDataColumn FieldName="Volume10pow9KM3" Caption="Volume, km³" DisplayFormat="N2">
            <HeaderCaptionTemplate>Volume, 10<sup>9</sup> &#215; km<sup>3</sup></HeaderCaptionTemplate>
        </DxTreeListDataColumn>
        <DxTreeListDataColumn FieldName="SurfaceGravity" Caption="Gravity" DisplayFormat="N2" ExportWidth="120">
            <HeaderCaptionTemplate>Gravity, m/s<sup>2</sup></HeaderCaptionTemplate>
        </DxTreeListDataColumn>
    </Columns>
    <TotalSummary>
        <DxTreeListSummaryItem SummaryType="TreeListSummaryItemType.Count" FieldName="Name" />
    </TotalSummary>
    <ToolbarTemplate>
        <DxToolbar>
            <DxToolbarItem Text="Export to XLSX" Click="ExportXlsx_Click" BeginGroup="true" />
            <DxToolbarItem Text="Export to XLS" Click="ExportXls_Click" BeginGroup="true" />
            <DxToolbarItem Text="Export to CSV" Click="ExportCsv_Click" BeginGroup="true" />
        </DxToolbar>
    </ToolbarTemplate>
</DxTreeList>

@code {
    ITreeList TreeList { get; set; }
    object TreeListData { get; set; }

    async Task ExportXlsx_Click() {
        await TreeList.ExportToXlsxAsync("ExportResult", new TreeListXlExportOptions() {
            CustomizeCell = OnCustomizeXlCell
        });
    }
    async Task ExportXls_Click() {
        await TreeList.ExportToXlsAsync("ExportResult", new TreeListXlExportOptions() {
            CustomizeCell = OnCustomizeXlCell
        });
    }
    async Task ExportCsv_Click() {
        await TreeList.ExportToCsvAsync("ExportResult");
    }
    void OnCustomizeXlCell(TreeListExportCustomizeCellEventArgs args) {
        if(args.ColumnFieldName == "TypeOfObject" && args.AreaType == SheetAreaType.DataArea)
            args.Formatting.Font = new XlCellFont() { Italic = true };
        args.Handled = true;
    }
}

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

Inheritance

Object

DevExpress.Blazor.Internal.GridExportOptionsBase

TreeListExportOptions

TreeListXlExportOptions