cxExportTLToCSVStream(TStream,TcxCustomTreeList,Boolean,Boolean,Char,TObject,TEncoding) Method

Exports content of a tree list control to a stream in CSV (comma-separated values) format.

Declaration

procedure cxExportTLToCSVStream(AStream: TStream; ATreeList: TcxCustomTreeList; AExpand: Boolean = True; ASaveAll: Boolean = True; const ASeparator: Char = ','; 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: True Default. The procedure exports all rows, including the rows hidden within collapsed tree list nodes. False The 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. False The procedure exports only selected rows.
ASeparator	Char	Optional. Specifies the character used to delimit exported values in the resulting CSV stream. The default separator character is a comma.
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 cxExportTLToCSVStream procedure to export tree list content to a stream in CSV format. In the resulting stream, every plain text line of values separated by commas corresponds to a data record.

Code Example: Export Tree List Content to a CSV Stream

The following code example exports Tree List content to a file in the CSV format:

Delphi

uses
  cxTLExportLink,   // Declares global export procedures
  dxSplashForms,    // Declares the TdxSplashFormManager class and related types
  cxTL;             // Declares the TcxTreeList component
// ...

procedure TMyForm.cxButtonExportToCSVClick(Sender: TObject);
var
  AStream: TMemoryStream;
begin
  AStream := TMemoryStream.Create;              // Creates a memory stream
  TdxSplashFormManager.WaitForm.Show(self);     // Displays a Wait Form before the export operation
  try
    // Export Tree List content to the created memory stream in the CSV format
    cxExportTLToCSVStream(AStream, cxTreeList1);
    AStream.SaveToFile('Departments.csv');    // Saves the resulting file
  finally
    AStream.Free;                               // Releases the memory stream
    TdxSplashFormManager.WaitForm.Hide;         // Hides the Wait Form once the operation is complete
  end;
end;

C++

#include "cxTLExportLink.hpp"   // Declares global export procedures
#include "dxSplashForms.hpp"    // Declares the TdxSplashFormManager class and related types
#include "cxTL.hpp"             // Declares the TcxTreeList component

// Add the following linker directives to the corresponding CPP source file:
#pragma link "cxTLExportLink"   // Required to use cxTLExportLink declarations
#pragma link "cxTL"             // Required to use cxTL.hpp declarations
// ...

void __fastcall TMyForm::cxButtonExportToCSVClick(TObject *Sender)
{
  TMemoryStream *AStream = new TMemoryStream();    // Creates a memory stream
  TdxSplashFormManager::WaitForm()->Show(this);    // Displays a Wait Form before the export operation
  try
  {
    // Export Tree List content to the created memory stream in the CSV format
    cxExportTLToCSVStream(AStream, cxTreeList1);
    AStream->SaveToFile("Departments.csv");     // Saves the resulting file
  }
  __finally
  {
    delete AStream;                               // Releases the memory stream
    TdxSplashFormManager::WaitForm()->Hide();     // Hides the Wait Form once the operation is complete
  }
}

The following image demonstrates exported content: