hiReportDeselectItems
hiReportDeselectItems(
g_reportField
l_itemIndexList
[ g_notify ]
)
=> t / nil
Description
Deselects 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 that contains the items.
|
|
l_itemIndexList
|
The items you want to deselect, 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); deselects items 1, 3, 6
’(’(2 4)); deselects items 2, 3, 4
’(’(1 3) 9 11); deselects 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.
|
Value Returned
|
t
|
The items were deselected.
|
|
nil
|
The items were not deselected.
|
Related Topics
Form and Field Functions
hiReportSelectItem
hiReportDeselectItems
hiReportDeselectAllItems
hiReportGetSelectedItems
hiCreateReportField
Return to top
