Tree.GetNode

table Tree.GetNode (

string ObjectName,

string NodeIndex )

Description

Returns a table containing the specified node's properties.

Parameters

ObjectName

(string) The name of the tree object.

NodeIndex

(string) The index of the node whose properties you want.

Returns

(table) A table containing the specified node's properties, 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.

Checked

boolean

True if the item is checked, false if it is not.

Note: If check boxes are not shown in the tree object, false will always be returned.

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 no data exists, 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.

See also: Related Actions