cxExportTLToText(string,TcxCustomTreeList,Boolean,Boolean,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; ASaveAll: Boolean = True; 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 AFileExt parameter value.
ATreeList	TcxCustomTreeList	The source tree list control.
AExpand	Boolean	If True, the procedure exports all nodes, including the nodes hidden within collapsed nodes. If False, the procedure exports only visible nodes.
ASaveAll	Boolean	Optional. If True, the procedure exports all or visible nodes, depending on the AExpand parameter value. If False, the procedure exports only selected nodes.
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 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 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. 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.

Code Example

Delphi

uses cxTLExportLink;
// ...
var
  AStream: TMemoryStream;
begin
  AStream := TMemoryStream.Create;
  cxExportTLToTextStream(AStream, cxDBTreeList1, True);
  AStream.SaveToFile('Departments.txt');
  AStream.Free;
end;

C++

#include "cxTLExportLink.hpp"
// ...
  TMemoryStream *AStream = nullptr;
  // ...
  AStream = new TMemoryStream();
  cxExportTLToHTMLStream(AStream, cxDBTreeList1, true);
  AStream->SaveToFile("Departments.txt");
  delete AStream;