UI Actions › Actions › Get Menu Item
Tries to find the UI menu element without triggering it.
Its properties (like state etc.) are a static snapshot from the time this action was triggered.
Parameters
Section titled “Parameters”Select the app which the menu belongs to.
Type: An app from a pre-defined list of available apps
Targeting options
Section titled “Targeting options”You can look up a menu item or sub menu by either …
- its title, e.g.
Contacts… - its path, e.g.
Edit > AutoFill > Contacts… - its segmented path, e.g.
Edit,AutoFill,Contacts…
A menu path is a single string containing the path segments separated by ">".
Leading and trailing whitespace in segments is stripped. The lookup deals gracefully with segments ending in either an ellipses or triple dots, if either variant exists in the menu structure, it'll be found.
Options:
- title
- path
- segmented path
Optional Menu item title
Section titled “ Menu item title”The menu item label as it occurs in the actual menu. Depending on the selected filter criteria, a partial title might be enough.
Type: Text
Title filter criteria
Section titled “Title filter criteria”Only available when searching by title.
Options:
- is
- contains
- begins with
- ends with
- matches regular expression
Optional Menu item path
Section titled “ Menu item path”The menu item's hierarchical path, starting at the main menu, separated by ">" characters, e.g. View > Translation > Translate to German.
Type: Text
Case-insensitive lookup
Section titled “Case-insensitive lookup”Enable if lowercase and uppercase shouldn't make a difference. Only available when searching by title or path.
Type: Boolean (YES/NO)
Optional Main menu title
Section titled “ Main menu title”The first segment of a menu item's path, e.g. View or Edit etc.
Type: Text
Optional Sub-menu or item #1
Section titled “ Sub-menu or item #1”The next segment of the menu item's path.
Type: Text
Optional Sub-menu or item #2
Section titled “ Sub-menu or item #2”The next segment of the menu item's path.
Type: Text
Optional Sub-menu or item #3
Section titled “ Sub-menu or item #3”The next segment of the menu item's path.
Type: Text
Optional Sub-menu or item #4
Section titled “ Sub-menu or item #4”The next segment of the menu item's path.
Type: Text
If menu item can't be found
Section titled “If menu item can't be found”If the specified menu item couldn't be found, the action can either cancel the workflow and raise an error, or it could silently and gracefully just return nothing. This might be preferable if you don't want the workflow to stop while being able to check for its return value in an If block down the line.
On success, it returns a menu item reference which can be used as input in other menu actions of UI Actions.
Options:
- stop and raise error
- return no value
Return Value
Section titled “Return Value”Related Links
Section titled “Related Links”- Search the UI Actions community forum for "Get Menu Item"