hiTreeTableSelectAllItems

hiTreeTableSelectAllItems(
g_treeField
[ g_notify ]
)
=> t / nil

Description

Selects all items 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 items with the mouse or keyboard keys.

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

Call hiTreeTableSelectAllItems after the form is displayed, that is, after hiDisplayForm is called to avoid any errors.

Arguments

g_treeField	The tree table field that contains the items.
g_notify	Runs the callback procedure of the tree table field. Specify nil if you do not want to execute the callback procedure.

Values Returned

t	The items were selected.
nil	The items were not selected.

Related Topics

Form and Field Functions

hiTreeTableSelectItem

hiTreeTableSelectItems

hiTreeTableDeselectAllItems

hiTreeTableGetSelectedItems

hiTreeTableGetSelectedItemCount

hiCreateTreeTable

Return to top