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

hiTreeTableDeselectItems

hiTreeTableDeselectItems(
g_treeField
l_items
[ g_notify ]
)
=> t / nil

Description

Deselects items in a tree table field. To deselect a single item, use hiTreeTableDeselectItem; to deselect all 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 items.

l_items

The items you want to select. l_items can either be a list of item names (symbols) or a list of ranges, specified as follows:

(s_parentItem x_topRow x_bottomRow)

where s_parentItem is the symbol of the parent item, and x_topRow and x_bottomRow are intergers specifying the range of items to select. (The first item is assumed to be 0, the second 1, and so on.)

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 items were deselected.

nil

The items were not deselected.

Related Topics

Form and Field Functions

hiTreeTableDeselectItem

hiTreeTableDeselectAllItems

hiTreeTableSelectItems

hiCreateTreeTable


Return to top
 ⠀
X