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.v20.1.dll

Declaration

public void ExportToXls(
    string path,
    XlsExportOptions options = null
)
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 XLS file with the specified XLS export options.

If the export options are not specified, the current report export options are used. To access the report export options, use the the report's XtraReport.ExportOptions property. The property contains the ExportOptions object whose ExportOptions.Xls property provides access to the XlsExportOptions object that contains the XLS export options.

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.

Examples

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.

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 { }
        }
See Also