Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

cxExportTLToHTMLStream(TStream,TcxCustomTreeList,Boolean,Boolean,TObject) Method

Exports content of a tree list control to a stream in HTML format.

#Declaration

Delphi
procedure cxExportTLToHTMLStream(AStream: TStream; ATreeList: TcxCustomTreeList; AExpand: Boolean = True; ASaveAll: Boolean = True; AHandler: TObject = nil);

#Parameters

Name Type Description
AStream TStream

The target stream.

ATreeList TcxCustomTreeList

The source tree list control.

AExpand Boolean

Optional. Specifies if all source tree list nodes are expanded:

  • If True (default), the procedure exports all rows, including the rows hidden within collapsed tree list nodes.
  • 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.
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 cxExportTLToHTMLStream procedure creates image files to display cell images as inline images in the output HTML stream. Use the cxExportGraphicClass constant to change the image container class for export image generation.

#Code Example: Export Tree List Content to an HTML Stream

VCL Tree List: A Source Tree List Example

The following code example exports tree list content to a file in HTML format:

uses cxTLExportLink;
// ...
var
  AStream: TMemoryStream;
begin
  AStream := TMemoryStream.Create;
  cxExportTLToHTMLStream(AStream, cxDBTreeList);
  AStream.SaveToFile('Departments.html');
  AStream.Free;
end;

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

Exported Tree List Data in HTML Format

See Also