PlayerPlayer.chooseHierPopup
Syntax
Player.chooseHierPopup(menu, submenu, item)
Player.chooseHierPopup(menu, submenu, item, holding: modifierKeys, extraClick: desiredState)
Parameters
popup is either a name, ID number, or location (an {x, y} list or a point datatype).
submenu is either a name or position number.
item is either a name or position number.
holding: modifierKeys, an optional parameter, is one or more modifier keys (command, shift, option, control, caps lock) or their abbreviations (cmd, shft, opt, ctrl, caps), added together in any order.
extraClick: desiredState, set to 'false' to disable the extra click (for a slight increase in speed but at the risk of the app not noticing the changed popup value)
Action
Chooses a command from a hierarchical pop-up menu.
Returns
True.
Examples
Player.chooseHierPopup("Don't", "Know", "One")
Errors
The pop-up menu, submenu or item does not exist or is not enabled.
Notes
- Many pop-ups cannot by identified by name. These are often implemented as "user items" rather than true pop-ups. Use Player's balloon help to determine the ID number (if any) and location.
- The holding label may be left off, though the result may be less readable.
- By default, Player matches only the number of characters specified in the verb parameter. This feature has the benefit of ignoring trailing punctuation, but will occasionally find a false match.
- By default, name matching is not case sensitive.
See Also
Player.choosePopup
Player.popupExists
Player.setCompleteMatch
Player.chooseHierPopupAt
Keywords
menus[4] dialogItems location modifiers
chooseHierPopupAt