cxExportTLToText(string,TcxCustomTreeList,Boolean,Boolean,string,string,string,string,TObject,TEncoding) Method
Exports content of a tree list control to a file in plain text format.
Declaration
procedure cxExportTLToText(const AFileName: string; ATreeList: TcxCustomTreeList; AExpand: Boolean = True; ASaveAll: Boolean = True; 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 TXT file. You can omit the file name extension because it is automatically updated from the |
ATreeList | TcxCustomTreeList | The source tree list control. |
AExpand | Boolean | Optional. If |
ASaveAll | Boolean | Optional. If |
ASeparator | string | The string that delimits cell values in the resulting text file. |
ABeginString | string | The prefix string added to each exported cell value. |
AEndString | string | The postfix string added to each exported cell value. |
AFileExt | string | Optional. Specifies the file name extension for the resulting plain text file. This parameter value always replaces the file name extension passed as a part of the |
AHandler | TObject | Optional. Accepts a handler object that implements the IcxExportBeforeSave and IcxExportProgress interfaces. You can handle the implemented events to customize export settings before a data export process or 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. The character encoding of the resulting text file. If this optional parameter accepts nil (in Delphi) or nullptr (in C++Builder), the export procedure uses the Unicode encoding. |
Remarks
Call the cxExportTLToText
procedure to export the tree list 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.