cxExportVGToCSV(string,TcxCustomVerticalGrid,Boolean,Char,Integer,string,TObject,TEncoding) Method

Exports content of a vertical grid control to a file in CSV (comma-separated values) format.

Declaration

delphi

procedure cxExportVGToCSV(const AFileName: string; AVerticalGrid: TcxCustomVerticalGrid; AExpand: Boolean = True; const ASeparator: Char = ','; ARecordPerBand: Integer = 8; 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.

| | AVerticalGrid | TcxCustomVerticalGrid |

The source vertical grid control.

| | AExpand | Boolean |

Optional. If True, the procedure exports all rows, including collapsed rows. If False, the procedure exports only visible rows.

| | ASeparator | Char |

Optional. Specifies the character used to delimit exported values in the resulting CSV file.

| | 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 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.

Remarks

Call the cxExportVGToCSV procedure to export source vertical grid content to a file in CSV (comma-separated values) format. Use this format if you need to load exported data to a third-party spreadsheet application while keeping the exported data size to a minimum.

Compared to CSV, plain text is more human-readable. You can call the cxExportVGToText procedure to export vertical grid data in plain text format.

Code Example: Export Vertical Grid Content as CSV

The following code example exports vertical grid content in CSV format:

Delphi
C++

delphi

uses cxExportVGLink;
// ...
  cxExportVGToCSV('Orders.csv', vgOrders);

cpp

#include "cxExportVGLink.hpp"
// ...
  cxExportVGToCSV("Orders.csv", vgOrders);

Grid Mode Limitations

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