GridControl.ExportToCsv(Stream, CsvExportOptions) Method

Exports the data displayed by the GridControl.DefaultView (the GridControl.MainView or the currently maximized detail View) to the specified stream in CSV format using the specified options.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v20.2.dll

Declaration

public void ExportToCsv(
    Stream stream,
    CsvExportOptions options
)
Public Sub ExportToCsv(
    stream As Stream,
    options As CsvExportOptions
)

Parameters

Name Type Description
stream Stream

A stream to which the control is exported.

options CsvExportOptions

An object that specifies export customization options and events. In data-aware export mode, initialize the parameter with a CsvExportOptionsEx object. In WYSIWYG export mode, initialize the parameter with a CsvExportOptions object.

Remarks

This method indirectly calls the PrintingSystemBase.ExportToCsv method of the XtraPrinting Library. If this library is not available, the method does nothing. For details on the ExportToCsv method, see the PrintingSystemBase.ExportToCsv topic.

For general information on exporting data in the Grid Control refer to Export Overview.

See Also