Back to Devexpress

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

vcl-cxgridexportlink-dot-exportgriddatatoxml-x28-79e3ce13-x29.md

latest3.2 KB
Original Source

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

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

Declaration

delphi
procedure ExportGridDataToXML(const AFileName: string; AGrid: TcxGrid; AExpand: Boolean = True; ASaveAll: Boolean = True; const AFileExt: string = 'xml'; AHandler: TObject = nil);

Parameters

NameTypeDescription
AFileNamestring

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

This procedure works similarly to ExportGridToXML. Unlike it, ExpressGridDataToXML exports only cell content in a simplified layout and ignores styles and look & feel settings.

See Also

VCL Data Grid: Data Export

ExportGridDataToXMLStream Global Procedure

ExportGridToXML Global Procedure

ExportGridToXMLStream Global Procedure

cxGridExportLink Unit