XtraReport.ExportToXls(String, XlsExportOptions) Method

Exports a report to the specified file in XLS format. This method exports data in WYSIWYG mode.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public void ExportToXls(
    string path,
    XlsExportOptions options = null
)

VB.NET

Public Sub ExportToXls(
    path As String,
    options As XlsExportOptions = Nothing
)

Parameters

Name	Type	Description
path	String	A String that is the full path to a file.

Optional Parameters

Name	Type	Default	Description
options	XlsExportOptions	null	The XLS export options. You can omit this parameter to use the current report export options.

Remarks

Note

Once the document export has started, it runs to completion and you cannot interrupt or cancel it.

This method exports a report to a file in XLS format with the specified XLS export options.

If you do not specify export options, the method uses the current report export options. To access the report export options, use the XtraReport.ExportOptions.Xls notation.

Important

This method overwrites files with the same name without confirmation.

Use the ExportToXlsAsync(String, XlsExportOptions, CancellationToken) method instead of ExportToXls to export a report asynchronously in a separate task.

Example

This example demonstrates how to export a report to XLS format.

The project uses the XtraReport.ExportToXls method with the XlsExportOptions object as a parameter.

Note

The complete sample project How to export a report to XLS format is available in the DevExpress Examples repository.

Form1.cs

using System;
using System.Windows.Forms;
using System.Diagnostics;
using DevExpress.XtraPrinting;
using DevExpress.XtraReports.UI;
// ...
        private void ExportToXLS() {
            // A path to export a report.
            string reportPath = "c:\\Test.xls";

            // Create a report instance.
            XtraReport1 report = new XtraReport1();

            // Get its XLS export options.
            XlsExportOptions xlsOptions = report.ExportOptions.Xls;

            // Set XLS-specific export options.
            xlsOptions.ShowGridLines = true;
            xlsOptions.TextExportMode = TextExportMode.Value;

            // Export the report to XLS.
            report.ExportToXls(reportPath);

            // Show the result.
            StartProcess(reportPath);
        }
        // Use this method if you want to automaically open
        // the created XLS file in the default program.
        public void StartProcess(string path) {
            Process process = new Process();
            try {
                process.StartInfo.FileName = path;
                process.Start();
                process.WaitForInputIdle();
            }
            catch { }
        }

Form1.vb

Imports System
Imports System.Windows.Forms
Imports System.Diagnostics
Imports DevExpress.XtraPrinting
Imports DevExpress.XtraReports.UI
' ...
        Private Sub ExportToXLS()
            ' A path to export a report.
            Dim reportPath As String = "c:\Test.xls"

            ' Create a report instance.
            Dim report As New XtraReport1()

            ' Get its XLS export options.
            Dim xlsOptions As XlsExportOptions = report.ExportOptions.Xls

            ' Set XLS-specific export options.
            xlsOptions.ShowGridLines = True
            xlsOptions.TextExportMode = TextExportMode.Value

            ' Export the report to XLS.
            report.ExportToXls(reportPath)

            ' Show the result.
            StartProcess(reportPath)
        End Sub
        ' Use this method if you want to automaically open
        ' the created XLS file in the default program.
        Public Sub StartProcess(ByVal path As String)
            Dim process As New Process()
            Try
                process.StartInfo.FileName = path
                process.Start()
                process.WaitForInputIdle()
            Catch
            End Try
        End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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/Reporting_how-to-export-different-report-groups-to-different-sheets-in-an-xls-file-e1352/Form1.cs#L70

report.CreateDocument();
report.ExportToXls(fileName,xlsExportOptions);

reporting-winforms-export-xls/CS/Form1.cs#L42

    // Export the report.
    report.ExportToXls(xlsExportFile, xlsExportOptions);
}