Skip to main content

cxExportTLToHTML(string,TcxCustomTreeList,Boolean,Boolean,string,TObject) Method

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

Declaration

procedure cxExportTLToHTML(const AFileName: string; ATreeList: TcxCustomTreeList; AExpand: Boolean = True; ASaveAll: Boolean = True; const AFileExt: string = 'html'; AHandler: TObject = nil);

Parameters

Name Type Description
AFileName string

The full path to the resulting HTML file. You can omit the file name extension because it is automatically updated from the AFileExt parameter value.

ATreeList TcxCustomTreeList

The source tree list control.

AExpand Boolean

Optional. If True, the procedure exports all nodes, including the nodes hidden within collapsed nodes. If False, the procedure exports only visible nodes.

ASaveAll Boolean

Optional. If True, the procedure exports all or visible nodes, depending on the AExpand parameter value. If False, the procedure exports only selected nodes.

AFileExt string

Optional. Specifies the file name extension for the resulting HTML 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 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 cxExportTLToHTML procedure creates image files to display cell images as inline images in the output HTML file. Use the cxExportGraphicClass constant to change the image container class for export image generation.

Code Example

Source Tree List Example

  cxExportTLToHTML('Departments.html', cxDBTreeList);

Exported Tree List Data in HTML Format

See Also