hiReportSelectItem

hiReportSelectItem(
g_reportField
g_itemIndex
[ g_notify ]
)
=> t / nil

Description

Selects an item in a report field. This function also executes the callback of the report 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 hiReportSelectItems. To select all items in a field, use hiReportSelectAllItems.

Arguments

g_reportField

The report field that contains the item.

g_itemIndex

The item you want to select, specified as an integer indicating the item’s position in ?choices. The first item in ?choices is 0, the second is 1, and so on. The ?choices argument is specified when the field is created with hiCreateReportField.

g_notify

Triggers the callback procedure of the report field.

The default value is nil.

Values Returned

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

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