Skip to main content

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

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

Declaration

procedure ExportGridDataToText(const AFileName: string; AGrid: TcxGrid; AExpand: Boolean = True; ASaveAll: Boolean = True; const AFileExt: string = 'txt'; AHandler: TObject = nil; AEncoding: TEncoding = nil);

Parameters

Name Type Description
AFileName string

The absolute or relative path to the resulting TXT 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:

  • If True (default), the procedure exports all or only visible rows depending on the AExpand parameter value.
  • If False, the procedure exports only selected rows.

The ASaveAll parameter value is ignored in grid mode.

AFileExt string

Optional. Specifies the file name extension for the resulting TXT 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.

Remarks

Call the ExportGridDataToText 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.

See Also