PrintingSystemBase.ExportToXls(String) Method

Exports a report to the specified file path in XLS format.

Namespace: DevExpress.XtraPrinting

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

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public void ExportToXls(
    string filePath
)

VB.NET

Public Sub ExportToXls(
    filePath As String
)

Parameters

Name	Type	Description
filePath	String	A String which specifies the file name (including the full path) for the created XLS file.

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 its current XLS-specific export options.

These options are represented by the XlsExportOptions object returned by the ExportOptions.Xls property of a printing system’s PrintingSystemBase.ExportOptions. This object provides the XlExportOptionsBase.ShowGridLines, XlExportOptionsBase.TextExportMode and other properties which are intended to specify parameters of the resulting XLS file.

If you want to ignore current export options of a report, and use your specific settings when a report is exported to XLS, you should use the overloaded PrintingSystemBase.ExportToXls method with 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) 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-wpf-override-print-commands/CS/MinimalisticReportPreviewDemo/MyDocumentPreviewControl.cs#L34

if(exportFormat.HasValue && exportFormat.Value == ExportFormat.Xls) {
    Document.PrintingSystem.ExportToXls("test.xls");
    System.Windows.MessageBox.Show("!");

VB.NET

reporting-wpf-override-print-commands/VB/MinimalisticReportPreviewDemo/MyDocumentPreviewControl.vb#L36

If exportFormat.HasValue AndAlso exportFormat.Value = DevExpress.XtraPrinting.ExportFormat.Xls Then
    Document.PrintingSystem.ExportToXls("test.xls")
    System.Windows.MessageBox.Show("!")