Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

cxExportPivotGridToText(string,TcxCustomPivotGrid,Boolean,string,TObject,TEncoding) Method

Exports content of a pivot grid to a file in plain text format.

#Declaration

Delphi
procedure cxExportPivotGridToText(const AFileName: string; APivotGrid: TcxCustomPivotGrid; AExpand: Boolean; const AFileExt: string = 'txt'; AHandler: TObject = nil; AEncoding: TEncoding = nil);

#Parameters

Name Type Description
AFileName string

The full path to the resulting plain text file. You can omit the file name extension because it is automatically updated from the AFileExt parameter value.

APivotGrid TcxCustomPivotGrid

The source pivot grid control.

AExpand Boolean

If True, the procedure expands all rows, including the collapsed nested rows. If False, the procedure exports only visible rows.

AFileExt string

Optional. Specifies the file name extension for the resulting HTML file. This parameter value always replaces the file name extension passed as a part of the AFileName parameter 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:

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 cxExportPivotGridToText procedure to export the pivot grid control’s content to a file in plain text format. This format stores data without formatting, style, or print layout information. Compared to CSV, exported TXT files are more human-readable.

#Code Example

VCL Pivot Grid: A Source Pivot Grid Example

The following code example exports pivot grid data without collapsed nested rows:

uses cxExportPivotGridLink;
// ...
  cxExportPivotGridToText('Payments.txt', UnboundPivotGrid, False, 'txt', nil, nil);

VCL Pivot Grid: Exported Pivot Grid Data in Plain Text Format

See Also