cxExportPivotGridToXML(string,TcxCustomPivotGrid,Boolean,string,TObject) Method

Exports content of a pivot grid to a file in XML format.

Declaration

delphi

procedure cxExportPivotGridToXML(const AFileName: string; APivotGrid: TcxCustomPivotGrid; AExpand: Boolean = True; const AFileExt: string = 'xml'; AHandler: TObject = nil);

Parameters

Name	Type	Description
AFileName	string

The full path to the resulting XML 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 |

Optional. 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 XML 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

Remarks

Call the cxExportPivotGridToXML procedure to export pivot grid content to a file in XML format. This procedure additionally creates a stylesheet file (XSL) with the same name. The browser relies on this stylesheet to display the exported XML document properly.

The cxExportPivotGridToXML procedure creates image files to display cell images as inline images in the output XML file. Use the cxExportGraphicClass constant to change the image container class for export image generation.

Code Example: Export Pivot Grid Content as XML

Delphi
C++

delphi

uses cxExportPivotGridLink;
// ...
  cxExportPivotGridToXML('Payments.xml', UnboundPivotGrid);

cpp

#include "cxExportPivotGridLink.hpp"
// ...
  cxExportPivotGridToXML("Payments.xml", UnboundPivotGrid);