PlayerPlayer.chooseHierMenu
Syntax
Player.chooseHierMenu(menu, submenu, item)
Player.chooseHierMenu(menu, submenu, item, holding: modifierKeys)
Player.chooseHierMenu(menu, submenu, item, repeatUntilSuccessful: desiredState)
Player.chooseHierMenu(menu, submenu, item, holding: modifierKeys, repeatUntilSuccessful: desiredState)
Parameters
menu is either a name or position number.
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.
repeatUntilSuccessful desiredState, an optional parameter, if true, Player will repeat the command until it is successful (or until the user aborts with command-period)
Action
Chooses a command from a hierarchical menu.
Returns
True.
Examples
Player.chooseHierMenu("Format", "Font", "Courier")
Errors
The menu or item does not exist or is not enabled.
Notes
- The holding label may be left off, though the result may be less readable.
- The repeatUntilSuccessful parameter (new in Player 1.1) is useful when the prior operation in a script may take a long time and leave the menu bar unavailable -- e.g. because a progress bar is in front. Instead of trapping the error with "try" in a repeat loop, add this parameter to instruct Player to periodically attempt to select the menu, yielding processor time to other applications in between tries. This parameter is optional, there is no need to set it to false.
- For position number, be sure to count the separator lines.
- For nested hierarchical menus, use the form "submenu;subsubmenu".
- The chooseMenu(...) verb has an optional submenu parameter, so it can be used instead of this verb.
- 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.chooseMenu
Player.menuExists
Player.setCompleteMatch
Keywords
menus[2] modifiers version1.1parameter
chooseHierPopup