ExportGridToXML(string,TcxGrid,Boolean,Boolean,string,TObject) Method

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

Declaration

delphi

procedure ExportGridToXML(const AFileName: string; AGrid: TcxGrid; AExpand: Boolean = True; ASaveAll: Boolean = True; 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.

| | AGrid | TcxGrid |

The source data grid control.

| | AExpand | Boolean |

Optional. If True, the procedure exports all rows, including the rows hidden within collapsed group rows and master rows. If False, the procedure exports only visible rows.

| | ASaveAll | Boolean |

Optional. Specifies if the procedure exports all available rows:

True Default. The procedure exports all or only visible rows depending on the AExpand parameter value.FalseThe procedure exports only selected rows.

The ASaveAll parameter value is ignored in grid mode.

| | 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 ExportGridToXML procedure to export grid content to a file in XML format. This procedure additionally creates a stylesheet file (XLS) with the same name. The browser relies on this stylesheet to display the exported XML document properly.

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

Code Example: Export Grid Content as XML

The following code example exports grid content to a file in XML format:

Delphi
C++

delphi

uses cxGridExportLink;
// ...
  ExportGridToXML('Employees.xml', cxGrid1, False);

cpp

#include "cxGridExportLink.hpp"
// ...
  ExportGridToXML("Employees.xml", cxGrid1, false);