ExportGridToText(string,TcxGrid,Boolean,Boolean,string,string,string,string,TObject,TEncoding) Method

Exports content of a data grid control to a file in plain text format.

Declaration

procedure ExportGridToText(const AFileName: string; AGrid: TcxGrid; AExpand: Boolean; ASaveAll: Boolean; const ASeparator: string; const ABeginString: string; const AEndString: string; const AFileExt: string = 'txt'; AHandler: TObject = nil; AEncoding: TEncoding = nil);

Parameters

Name	Type	Description
AFileName	string	The full path to the resulting text 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	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	If True, the procedure exports all or visible rows, depending on the AExpand parameter value. If False, the procedure exports only selected rows. In grid mode, the ASaveAll parameter value is ignored.
ASeparator	string	Specifies the string used to delimit exported values in the resulting plain text file.
ABeginString	string	Specifies the prefix string for every cell value.
AEndString	string	Specifies the postfix string for every cell value.
AFileExt	string	Optional. Specifies the file name extension for the resulting text 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 an export operation and track its progress. 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 plain text file. If nil (in Delphi) or nullptr (in C++Builder) is passed as the AEncoding parameter, the procedure uses the TEncoding.Default encoding.

Remarks

Call the ExportGridToText procedure to export the data grid control’s content to a file in plain text format. This format stores data without formatting, style, or print layout information. Compared to CSV, exported TXT files are more human-readable.

Example

The following code example exports grid content to a plain text file when the ABeginString parameter is set to '|':

Delphi

  ExportGridToText('Employees.txt', cxGrid1, False, True, '', '|', '', 'txt');

C++

  ExportGridToText("Employees.txt", cxGrid1, false, true, "", "|", "", "txt");