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:
|
ASaveAll | Boolean | Optional. Specifies if the procedure exports all available 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: |
AEncoding | TEncoding | Optional. Specifies the character encoding format of the resulting CSV stream. If |
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
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: