ExportGridDataToCSV(string,TcxGrid,Boolean,Boolean,Char,string,TObject,TEncoding) Method

Exports cell content of a data grid to a CSV (comma-separated values) file.

Declaration

delphi

procedure ExportGridDataToCSV(const AFileName: string; AGrid: TcxGrid; AExpand: Boolean = True; ASaveAll: Boolean = True; const ASeparator: Char = ','; const AFileExt: string = 'csv'; AHandler: TObject = nil; AEncoding: TEncoding = nil);

Parameters

Name	Type	Description
AFileName	string

The absolute or relative path to the resulting CSV file.

You can omit the file name extension because it is automatically updated from the AFileExt parameter value.

| | AGrid | TcxGrid |

The source data grid control.

| | AExpand | Boolean |

Optional. If True, the procedure exports all rows, including the rows hidden within collapsed group rows and master rows. If False, the procedure exports only visible rows.

| | ASaveAll | Boolean |

Optional. Specifies if the procedure exports all available rows:

True Default. The procedure exports all or only visible rows depending on the AExpand parameter value.FalseThe procedure exports only selected rows.

The ASaveAll parameter value is ignored in grid mode.

| | ASeparator | Char |

Optional. Specifies the character used to delimit exported values in the resulting CSV file. The default separator character is a comma.

| | AFileExt | string |

Optional. Specifies the file name extension for the resulting CSV file.

This parameter value always replaces the file name extension passed as a part of the AFileName parameter value.

| | AHandler | TObject |

Optional. Specifies a handler object that should implement the IcxExportBeforeSave and/or IcxExportProgress interfaces to allow you to perform specific actions before the beginning of an export operation and track its progress.

Tip

Refer to the following topic for detailed information on how to create and use handler objects:

How to: Track Data Export Progress

| | AEncoding | TEncoding |

Optional. Specifies the character encoding format of the resulting CSV stream.

If nil (in Delphi) or nullptr (in C++Builder) is passed as the AEncoding parameter ( default ), the procedure uses the TEncoding.Default encoding.