The requested page is not available for the requested platform. You are viewing the content for Default platform.

XtraReport.ExportToXls(Stream, XlsExportOptions) Method

Exports a report to the specified file path in XLS format.This method exports data in WYSIWYG mode. Certain controls (e.g., a GridControl) can be exported to XLS(XLSX) format in a faster data-aware export mode, optimized for subsequent analysis of data in MS Excel. To learn how to employ data-aware export, see Export to XLS and XLSX Formats.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

Declaration

public void ExportToXls(
    Stream stream,
    XlsExportOptions options
)
Public Sub ExportToXls(
    stream As Stream,
    options As XlsExportOptions
)

Parameters

Name Type Description
stream Stream

A Stream object to which the created XLS file should be sent.

options XlsExportOptions

A XlsExportOptions object which specifies the XLS export options to be applied when a report is exported.

Remarks

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

Use this method to export a report to an XLS file using the specified XLS export options (like XlExportOptionsBase.ShowGridLines, XlExportOptionsBase.TextExportMode, etc.).

Note that in this instance the current report export options, which are represented by the XlsExportOptions object returned by the ExportOptions.Xls property of a report's XtraReport.ExportOptions, are ignored.

If, instead, you want to use the current export options of a report, you should call the overloaded XtraReport.ExportToXls method without the options parameter.

To learn more, see Export to XLS.

See Also