Skip to main content

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

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

Declaration

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

Parameters

Name Type Description
AFileName string

The full path to the resulting XML 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 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 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 cxExportTLToXML procedure to export tree list content to a file in XML format. This procedure additionally creates a stylesheet file (XSL) with the same name. The browser relies on this stylesheet to display the exported XML document properly.

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

Code Example

VCL Tree List: A Source Tree List Example

  cxExportTLToXML('Departments.xml', cxDBTreeList1);

VCL Tree List: Exported Tree List Data in XML Format

See Also