ExportGridToTextStream(TStream,TcxGrid,Boolean,Boolean,string,string,string,TObject,TEncoding) Method
Exports content of a data grid control to a stream in plain text format.
Declaration
procedure ExportGridToTextStream(AStream: TStream; AGrid: TcxGrid; AExpand: Boolean; ASaveAll: Boolean; const ASeparator: string; const ABeginString: string; const AEndString: string; AHandler: TObject = nil; AEncoding: TEncoding = nil);
Parameters
Name | Type | Description |
---|---|---|
AStream | TStream | The target stream. |
AGrid | TcxGrid | The source data grid control. |
AExpand | Boolean | If |
ASaveAll | Boolean | Optional. Specifies if the procedure exports all available rows:
The |
ASeparator | string | Specifies the string used to delimit exported values in the resulting plain text stream. |
ABeginString | string | Specifies the prefix string for every cell value. |
AEndString | string | Specifies the postfix string for every 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 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 ExportGridToTextStream
procedure to export the data grid control’s content to a stream in plain text format. This format stores data without formatting, style, or print layout information. Compared to CSV, the plain text format is more human-readable.
Code Example
The following code example exports grid content to a stream in plain text format when the ABeginString
parameter is set to '|'
:
uses cxGridExportLink;
// ...
var
AStream: TMemoryStream;
begin
AStream := TMemoryStream.Create;
ExportGridToTextStream(AStream, cxGrid1, False, True, '', '|', '', 'txt');
AStream.SaveToFile('Employees.txt');
AStream.Free;
end;
The following image demonstrates the exported content of a memory stream when it is saved to a TXT file: