PrintingSystemBase.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.v23.2.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 which specifies the file name (including the full path) for the created XLS file.
options	XlsExportOptions	An 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 (e.g. XlExportOptionsBase.ShowGridLines, XlExportOptionsBase.TextExportMode and so on).

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 printing system’s PrintingSystemBase.ExportOptions, are ignored.

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

Note

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

For more information, see Export to XLS.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportToXls(String, XlsExportOptions) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

reporting-winforms-export-xls-diff-sheets/CS/WindowsApplication1/Form1.cs#L45

else {
    control.PrintingSystem.ExportToXls("XtraReport5.xls",exportOptionsForm.ExportOptions);
}

VB.NET

reporting-winforms-export-xls-diff-sheets/VB/WindowsApplication1/Form1.vb#L44

Else
    control.PrintingSystem.ExportToXls("XtraReport5.xls", exportOptionsForm.ExportOptions)
End If