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

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

Declaration

delphi

procedure ExportGridToHTMLStream(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:

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.

| | 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

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

Code Example: Export Grid Content to an HTML Stream

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

Delphi
C++

delphi

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

cpp

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

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