Skip to main content

PrintingSystemBase.ExportToCsv(Stream, CsvExportOptions) Method

Exports a document to the specified stream 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

public virtual void ExportToCsv(
    Stream stream,
    CsvExportOptions options
)

Parameters

Name Type Description
stream Stream

A Stream object to which the created CSV file should be sent.

options CsvExportOptions

A CsvExportOptions object which specifies the CSV export options to be applied when a document 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 document to a CSV format using the specified CSV export options (e.g. TextExportOptionsBase.Encoding, TextExportOptionsBase.Separator and so on).

Note that in this instance the current printing system’s 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.

For more information, see Export to CSV.

See Also