Tree.GetChildren

OverviewExamples

table Tree.GetChildren (

string ObjectName,

string ParentNodeIndex )

Description

Returns a table containing child data tables.

Parameters

ObjectName

(string) The name of the tree object.

ParentNodeIndex

(string) The index of the node whose child data will be retrieved.

Tip: Use an index of "0" to reference the root-level nodes.

Returns

(table) A numerically indexed table of child data tables, indexed by the following keys:

KEY	TYPE	DESCRIPTION
Text	string	The text of the current item.
Data	string	The data of the current item.
Selected	boolean	True if the item is selected, false if it is not.
Expanded	boolean	True if the item is expanded, false if it is not.
NodeIndex	string	The current item's node index.
ImageIndex	number	The icon index that the current item will use when not selected. The icon file is specified in the Tree's properties. See the ImageList key in the Tree.SetProperties action for more information.
SelectedImageIndex	number	The icon index that the current item will use when selected. The icon file is specified in the Tree's properties. See the ImageList key in the Tree.SetProperties action for more information.

If there are no child elements at the specified node or an error occurs, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.