Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiTreeTableDeselectItem

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

Description

Deselects an item in a tree table field. To deselect more than one item, use hiTreeTableDeselectItems. To deselect all selected items in a field, use hiTreeTableDeselectAllItems.

This function is the programmatic equivalent of deselecting items with the mouse or keyboard keys.

Arguments

g_treeField

The tree table field that contains the item.

g_item

The item you want to deselect. It is a symbol of the tree item, which can be obtained from the return value of the hiCreateTreeItem.

g_notify

Opens the callback procedure of the tree table field. Specify nil if you do not want to execute the callback procedure.

Values Returned

t

The item was deselected.

nil

The item was not deselected.

Related Topics

Form and Field Functions

hiTreeTableDeselectItems

hiTreeTableDeselectAllItems

hiTreeTableSelectItem

hiCreateTreeTable


Return to top
 ⠀
X