hiTreeTableSelectItem

hiTreeTableSelectItem(
g_treeField
g_item
[ g_notify ]
)
=> t / nil

Description

Selects an item in a tree table field. This function also executes the callback of the tree table field if you specify t as the value of the g_notify argument.

This function is the programmatic equivalent of selecting an item with the mouse or keyboard keys.

To select more than one item, use hiTreeTableSelectItems. To select all items in a field, use hiTreeTableSelectAllItems.

Arguments

g_treeField	The tree table field that contains the item.
g_item	The item you want to select. It is a symbol of the tree item, which can be obtained from the return value of the hiCreateTreeItem.
g_notify	Runs the callback of the tree table field. Specify nil if you do not want to execute the callback.

Values Returned

t	The item was selected.
nil	The item was not selected.

Related Topics

Form and Field Functions

hiTreeTableSelectItems

hiTreeTableSelectAllItems

hiTreeTableDeselectItem

hiTreeTableGetSelectedItems

hiTreeTableGetSelectedItemCount

hiCreateTreeTable

Return to top