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

hiReportSelectAllItems

hiReportSelectAllItems(
g_reportField
[ g_notify ]
)
=> t / nil

Description

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

g_notify

Triggers the callback procedure of the report field. The default value is nil.

Value Returned

t

The items were selected.

nil

The items were not selected.

Related Topics

Form and Field Functions

hiReportSelectItem

hiReportDeselectItem

hiReportDeselectItems

hiReportDeselectAllItems

hiReportGetSelectedItems

hiCreateReportField


Return to top
 ⠀
X