hiSetTypeinMenuItemCompleterList

hiSetTypeinMenuItemCompleterList(
r_menu 
s_menuItem 
l_completerList 
) 
=> t / nil

Description

Replaces the list of strings that store the history of user inputs for the specified type-in menu item. This list is used to assist user inputs in the type-in menu item.

Arguments

r_menu	The popup or pull-down menu containing the type-in menu item.
s_menuItem	The symbol name of the type-in menu item.
l_completerList	The list of strings that must replace the current history list of the type-in menu item used to assists users to input data.

Values Returned

t	The list of strings was replaced successfully.
nil	The list of strings could not be replaced.

Examples

Consider that the menu MyMenu contains the type-in menu item MyTypein and the completerType argument was not set to none when this menu item was created using hiCreateTypeinMenuItem. To replace the list of strings that assist users to input data in MyTypein with a custom list, use the following command:

hiSetTypeinMenuItemCompleterList( MyMenu 'MyTypein '("One" "Two" "Three" "Four" ) )

Related Topics

Menu Functions

hiCreateTypeinMenuItem

hiCreateMenuItem

hiAddMenuItem

hiCreateSeparatorMenuItem

hiDeleteMenuItem

hiEnableMenuItem

Return to top