hiReportDeselectItem

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

Description

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

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 that contains the item.
g_itemIndex	The item you want to deselect, 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 deselected
nil	The item was not deselected.

Related Topics

Form and Field Functions

hiReportSelectItem

hiReportDeselectItems

hiReportDeselectAllItems

hiReportGetSelectedItems

hiCreateReportField

Return to top