The requested page is not available for the requested platform. You are viewing the content for Default platform.

XtraReport.ExportToCsv(String, CsvExportOptions) Method

Exports a report to the specified file path in CSV format using the specified CSV-specific options.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

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

Parameters

Name Type Description
path String

A String which specifies the file name (including the full path) for the created CSV file.

options CsvExportOptions

A CsvExportOptions object which specifies the CSV export options to be applied when a report is exported.

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 a CSV file using the specified CSV export options (like TextExportOptionsBase.Encoding, TextExportOptionsBase.Separator, etc.) Note that in this instance the current report export options, which are represented by the CsvExportOptions object returned by the ExportOptions.Csv property of a report's XtraReport.ExportOptions, are ignored.

If, instead, you want to use the current export options of a report, you should call the overloaded XtraReport.ExportToCsv method without the options parameter.

Note

This method overwrites any files present at the specified path that have the same file name without any warnings.

Note

For more information on using the ExportToCsv method, and limitations on export to CSV, please refer to the Export to CSV document.

Examples

The following example demonstrates how to export a report to CSV format. To do this, the XtraReport.ExportToCsv method should be used. It also demonstrates what specific CsvExportOptions may be used when a report is exported to CSV.

For this example to work, you first need to add a new report (named XtraReport1) to your project, drop some report controls onto it, and then execute the code below (for instance, in the Button.Click event handler of any button on a form). Note also, that if you want the resulting file to be automatically opened in the default program which is used to open *.csv files in your system, you can call the StartProcess method, which is also shown in this example.

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