ExportGridToTextStream(TStream,TcxGrid,Boolean,Boolean,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 = True; ASaveAll: Boolean = True; AHandler: TObject = nil; AEncoding: TEncoding = nil);
Parameters
Name | Type | Description |
---|---|---|
AStream | TStream | The target stream. |
AGrid | TcxGrid | The source data grid control. |
AExpand | Boolean | Optional. If |
ASaveAll | Boolean | Optional. If |
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. 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 plain text 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.
Example
The following code example exports grid content to a plain text file:
var
AStream: TMemoryStream;
begin
AStream := TMemoryStream.Create;
ExportGridToText(AStream, cxGrid1, False);
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: