XtraReport.ExportToCsv(String, CsvExportOptions) Method

Exports a report to the specified file in CSV format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.1.dll

Declaration

public void ExportToCsv(
    string path,
    CsvExportOptions options = null
)
Public Sub ExportToCsv(
    path As String,
    options As CsvExportOptions = Nothing
)

Parameters

Name Type Description
path String

The path to the exported CSV file.

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 CSV file with the specified CSV 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.Csv property provides access to the CsvExportOptions object that contains the CSV export options.

IMPORTANT

This method overwrites files with the same name without confirmation.

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

Examples

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.

NOTE

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

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

private void ExportToCSV()
{
    // 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 automaically 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 { }
}
See Also