cxExportVGToText(string,TcxCustomVerticalGrid,Boolean,Integer,string,TObject,TEncoding) Method

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

Declaration

procedure cxExportVGToText(const AFileName: string; AVerticalGrid: TcxCustomVerticalGrid; AExpand: Boolean; ARecordPerBand: Integer = 8; 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.
AVerticalGrid	TcxCustomVerticalGrid	The source vertical grid control.
AExpand	Boolean	If True, the procedure exports all rows, including collapsed rows. If False, the procedure exports only visible rows.
ARecordPerBand	Integer	Optional. Specifies the number of records grouped per band in the resulting file.
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 cxExportVGToText procedure to export the vertical 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.

Code Example

The following code example exports vertical grid content in plain text format:

Delphi

uses cxExportVGLink;
// ...
  cxExportVGToText('Orders.txt', vgOrders, True);

C++

#include "cxExportVGLink.hpp"
// ...
  cxExportVGToText("Orders.txt", vgOrders, true);

Grid Mode Limitations

The cxExportVGToText procedure exports only the currently cached records when the source vertical grid control is in Grid Mode.