Skip to main content
All docs
V25.1
  • 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

    VCL Tree List: A Source Tree List Example

    The following code example exports tree list content to a file in CSV format:

    uses cxTLExportLink;
    // ...
    var
      AStream: TMemoryStream;
    begin
      AStream := TMemoryStream.Create;
      cxExportTLToCSVStream(AStream, cxDBTreeList);
      AStream.SaveToFile('Departments.csv');
      AStream.Free;
    end;
    

    The following image demonstrates the exported content of a memory stream when it is saved to a file:

    VCL Tree List: Exported Tree List Data in CSV Format

    See Also