PrintingSystemBase.ExportToCsv(String, CsvExportOptions) Method

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

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v24.1.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public void ExportToCsv(
    string filePath,
    CsvExportOptions options
)

VB.NET

Public Sub ExportToCsv(
    filePath As String,
    options As CsvExportOptions
)

Parameters

Name	Type	Description
filePath	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 document is exported.

Remarks

Use this method to export a document to a CSV file using the specified CSV export options (e.g. TextExportOptionsBase.Encoding, TextExportOptionsBase.Separator and so on).

Once the document export has started, it will run until the resulting document is complete and cannot be interrupted or canceled in the process.

Note that in this instance the current printing system export options, which are represented by the CsvExportOptions object returned by the ExportOptions.Csv property of a printing system’s PrintingSystemBase.ExportOptions, are ignored.

If, instead, you want to use the current export options of a printing system, you should call the overloaded PrintingSystemBase.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.

For more information, see Export to CSV.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportToCsv(String, 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.

C#

reporting-winforms-print-report-in-dot-matrix-printer/CS/Form1.cs#L24

private void barButtonItem2_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
    printControl1.PrintingSystem.ExportToCsv(Application.StartupPath + "\\temporary.csv", new DevExpress.XtraPrinting.CsvExportOptions(",", Encoding.Default));

VB.NET

reporting-winforms-print-report-in-dot-matrix-printer/VB/Form1.vb#L26

Private Sub barButtonItem2_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs) Handles barButtonItem2.ItemClick
    printControl1.PrintingSystem.ExportToCsv(Application.StartupPath & "\temporary.csv", New DevExpress.XtraPrinting.CsvExportOptions(",", Encoding.Default))