GenerateTree
Mon 01 January 2018Syntax
GenerateTree(&rowset [, TreeEventField])
Description
Use the GenerateTree function to display data in a tree format, with nodes and leaves. The result of the GenerateTree function is an HTML string, which can be displayed in an HTML area control. The tree generated by GenerateTree is called an HTML tree .
The GenerateTree function can be used in conjunction with the Tree Classes to display data from trees created using Tree Manager.
The GenerateTree function works with both an HTML area control and a hidden field. The TreeEventField parameter contains the contents of the invisible character field used to process the HTML tree events.
When an end user selects a node, expands a node, collapses a node, or uses one of the navigation links, that event (end-user action) is passed to the invisible field, and the invisible field's FieldChange PeopleCode is executed.
Parameters
Field or Control |
Definition |
---|---|
&rowset |
Specify the name of the rowset you've populated with tree data. |
TreeEventField |
Specify the contents of the invisible character field used to process the HTML tree events. The first time the GenerateTree function is used, that is, to generate the initial tree, you do not need to include this parameter. Subsequent calls require this parameter. |
Returns
A string that contains HTML code that can be used with the HTML control to display a tree.