cxExportVGToXML(string,TcxCustomVerticalGrid,Boolean,Integer,string,TObject) Method

Exports content of a vertical grid control to a file in XML format.

Declaration

delphi

procedure cxExportVGToXML(const AFileName: string; AVerticalGrid: TcxCustomVerticalGrid; AExpand: Boolean = True; ARecordPerBand: Integer = 8; const AFileExt: string = 'xml'; AHandler: TObject = nil);

Parameters

Name	Type	Description
AFileName	string

The absolute or relative path to the resulting XML file.

You can omit the file name extension because it is automatically updated from the AFileExt parameter value.

| | AVerticalGrid | TcxCustomVerticalGrid |

The source vertical grid control.

| | AExpand | Boolean |

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

| | ARecordPerBand | Integer |

Optional. Specifies the number of records grouped per band in the resulting file.

| | 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 cxExportVGToXML procedure to export vertical 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.

Code Example: Export Vertical Grid Content as XML

The following code example exports vertical grid content in XML format:

Delphi
C++

delphi

uses cxExportVGLink;
// ...
  cxExportVGToXML('Orders.xml', vgOrders);

cpp

#include "cxExportVGLink.hpp"
// ...
  cxExportVGToXML("Orders.xml", vgOrders);

Grid Mode Limitations

The cxExportVGToXML procedure exports only the currently cached records when the source vertical grid control is in Grid Mode.