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

hiReportSelectItems

hiReportSelectItems(
g_reportField
l_itemIndexList
[ g_notify ]
)
=> t / nil

Description

Selects items 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 items 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 items.

l_itemIndexList

The items you want to select, specified as a list of integers indicating the items’ positions in ?choices. The first item in ?choices is 0, the second is 1, and so on. You can specify a range of items as a list within the list.

For example:

’(1 3 6); selects items 1, 3, 6
’(’(2 4)); selects items 2, 3, 4
’(’(1 3) 9 11); selects items 1, 2, 3, 9, 11

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

nil

The items were not selected.

Related Topics

Form and Field Functions

hiReportSelectItem

hiReportSelectAllItems

hiReportDeselectItem

hiReportDeselectItems

hiReportDeselectAllItems

hiReportGetSelectedItems

hiCreateReportField


Return to top
 ⠀
X