Skip to main content

XtraReport.ExportToCsv(Stream, CsvExportOptions) Method

Exports a report to the specified stream in CSV format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

public void ExportToCsv(
    Stream stream,
    CsvExportOptions options = null
)

Parameters

Name Type Description
stream Stream

A Stream for output data.

Optional Parameters

Name Type Default Description
options CsvExportOptions null

The CSV 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 CSV format with the specified CSV 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.Csv notation.

Use the ExportToCsvAsync(Stream, CsvExportOptions, CancellationToken) method instead of ExportToCsv to export a report asynchronously in a separate task.

Example

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

The project uses the XtraReport.ExportToCsv method with the CsvExportOptions object as a parameter.

using System.Text;
using System.Diagnostics;
using System.Globalization;
using DevExpress.XtraPrinting;
using DevExpress.XtraReports.UI;
// ...

private void ExportToCSV()
{
    // Specify a path to export a report.
    string reportPath = "c:\\Test.csv";

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

    // Get its CSV export options.
    CsvExportOptions csvOptions = report.ExportOptions.Csv;

    // Set CSV-specific export options.
    csvOptions.Encoding = Encoding.Unicode;
    csvOptions.Separator = CultureInfo.CurrentCulture.TextInfo.ListSeparator.ToString();

    // Export the report to CSV.
    report.ExportToCsv(reportPath);

    // Show the result.
    StartProcess(reportPath);
}

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

The following code snippets (auto-collected from DevExpress Examples) contain references to the ExportToCsv(Stream, CsvExportOptions) 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.

See Also