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

hiReportDeselectAllItems

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

Description

Deselects all selected 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.

To deselect more than one item, use hiReportDeselectItems. To deselect all selected items in a field, use hiReportDeselectAllItems.

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

Arguments

g_reportField

The report field.

g_notify

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

Value Returned

t

The items were deselected.

nil

The items were not deselected.

Related Topics

Form and Field Functions

hiReportSelectItem

hiReportSelectItems

hiReportSelectAllItems

hiReportDeselectItem

hiReportDeselectItems

hiReportGetSelectedItems

hiCreateReportField


Return to top
 ⠀
X