cxExportTLToTextStream(TStream,TcxCustomTreeList,Boolean,Boolean,string,string,string,TObject,TEncoding) Method

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

Declaration

procedure cxExportTLToTextStream(AStream: TStream; ATreeList: TcxCustomTreeList; AExpand: Boolean = True; ASaveAll: Boolean = True; const ASeparator: string = ''; const ABeginString: string = ''; const AEndString: string = ''; AHandler: TObject = nil; AEncoding: TEncoding = nil);

Parameters

Name	Type	Description
AStream	TStream	The target stream.
ATreeList	TcxCustomTreeList	The source tree list control.
AExpand	Boolean	Optional. Specifies if all source tree list nodes are expanded: If True (default), the procedure exports all rows, including the rows hidden within collapsed list nodes. If False, the procedure exports only visible nodes.
ASaveAll	Boolean	Optional. Specifies if the procedure exports all available rows: If True (default), the procedure exports all or only visible nodes, depending on the AExpand parameter value. If False, the procedure exports only selected nodes.
ASeparator	string	Optional. The string that delimits cell values in the resulting text file.
ABeginString	string	Optional. The prefix string added to each exported cell value.
AEndString	string	Optional. The postfix string added to each exported cell 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. 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, 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

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();
  cxExportTLToTextStream(AStream, cxDBTreeList1, true);
  AStream->SaveToFile("Departments.txt");
  delete AStream;