LinkBase.ExportToXls(String, XlsExportOptions) Method

Exports a report to the specified file path in XLS format using the defined XLS-specific options.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v24.1.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public void ExportToXls(
    string filePath,
    XlsExportOptions options
)

VB.NET

Public Sub ExportToXls(
    filePath As String,
    options As XlsExportOptions
)

Parameters

Name	Type	Description
filePath	String	A String value, specifying the file name (including the full path) for the created XLS file.
options	XlsExportOptions	An XlsExportOptions object, specifying the XLS export options to be applied when a report is exported.

Remarks

This method overwrites any files present at the specified path that have the same file name without any warnings.

Once the document export has started, it will run until the resulting document is complete and cannot be interrupted or canceled in the process.

The following two modes of Excel export are available.

• Data-Aware Export

  This export mode is optimized for subsequent data analysis within Microsoft Excel. Various data shaping options that are applied within the control are retained in the output XLS-XLSX documents (such as native Excel grouping, sorting and filtering settings, as well as improved support for Excel formulas).

  The LinkBase class does not support this export mode and to use the data-aware export, it is required to call the corresponding methods of specific controls (e.g., GridControl).

• WYSIWYG Export

  With this export mode, the layout of a control’s cells is retained in the resulting Excel documents while specific data shaping options may not be retained.

  This is the only export method that is supported by the LinkBase class.