cxExportTLToText(string,TcxCustomTreeList,Boolean,Boolean,string,TObject,TEncoding) Method

Exports content of a tree list control to a file in plain text format.

Declaration

delphi

procedure cxExportTLToText(const AFileName: string; ATreeList: TcxCustomTreeList; AExpand: Boolean; 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.

| | ATreeList | TcxCustomTreeList |

The source tree list control.

| | AExpand | Boolean |

Optional. Specifies if all source tree list nodes are expanded:

True Default. The procedure exports all rows, including the rows hidden within collapsed tree list nodes.FalseThe procedure exports only visible rows. | | ASaveAll | Boolean |

Optional. Specifies if the procedure exports all available rows:

True Default. The procedure exports all or only visible rows depending on the AExpand parameter value.FalseThe procedure exports only selected rows. | | 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 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.

Code Example: Export Tree List Content as TXT

Delphi
C++

delphi

uses cxTLExportLink;
// ...
  cxExportTLToText('Departments.txt', cxDBTreeList, True);

cpp

#include "cxTLExportLink.hpp"
// ...
  cxExportTLToText("Departments.txt", cxDBTreeList, True);