hiCollapseTreeItem

hiCollapseTreeItem(
g_item
[ g_notify ]
)
=> t / nil

Description

Collapses the tree item you specify. This function also executes the collapse 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 collapsing an item with the mouse or keyboard keys.

Arguments

g_item	The item you want to collapse. g_item can either be the return value of hiCreateTreeItem or a symbol specifying the item name.
g_notify	Runs the collapse callback of the tree table field.

Values Returned

t	The item was collapsed.
nil	The item does not have a tree under it, the item was not expanded, or there was an error.

Related Topics

Form and Field Functions

hiExpandTreeItem

hiGetTreeItems

hiCreateTreeTable

Return to top