ExportGridToXMLStream(TStream,TcxGrid,Boolean,Boolean,TObject) Method

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

Declaration

procedure ExportGridToXMLStream(AStream: TStream; AGrid: TcxGrid; AExpand: Boolean = True; ASaveAll: Boolean = True; AHandler: TObject = nil);

Parameters

Name	Type	Description
AStream	TStream	The target stream.
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: If True (default), the procedure exports all or only visible rows depending on the AExpand parameter value. If False, the procedure exports only selected rows. The ASaveAll parameter value is ignored in grid mode.
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 ExportGridToXMLStream procedure to export grid content to a file in XML format. The procedure includes stylesheet information in the resulting XML stream.

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

Code Example

The following code example exports grid content to a file in XML format without expanding detail pages:

Delphi

uses cxGridExportLink;
// ...
var
  AStream: TMemoryStream;
begin
  AStream := TMemoryStream.Create;
  ExportGridToXMLStream(AStream, cxGrid1, False);
  AStream.SaveToFile('Employees.xml');
  AStream.Free;
end;

C++

#include "cxGridExportLink.hpp"
// ...
  TMemoryStream *AStream = nullptr;
  AStream = new TMemoryStream();
  ExportGridToXMLStream(AStream, cxGrid1, false);
  AStream->SaveToFile("Employees.xml");
  delete AStream;

The following image demonstrates the exported content of a memory stream when it is saved to a file: