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
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 full path to the resulting CSV file. You can omit the file name extension because it is automatically updated from the |
AVerticalGrid | TcxCustomVerticalGrid | The source vertical grid control. |
AExpand | Boolean | Optional. If |
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 |
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 CSV file. If |
Remarks
Example
The following code example exports vertical grid content in CSV format:
Note
The cxExportVGToCSV
procedure exports only the currently cached records when the source vertical grid control is in Grid Mode.