The menuAssignments setting is one of the settings of an Action plug-in that can be configured in its configuration file. For more information, see Elvis 6 Action plug-ins - configuration settings.
Required | Yes |
Description |
Controls from which menu(s) the plug-in is available, this can be a combination of the following:
Menu assignments are required in the action configuration, you will need to define at least one to make the plug-in available in the user interface. |
Basic setting |
|
Menu assignment - <menuAssignment/>
One or more menuAssignment tags can be defined, where each menuAssignment "id" can only be defined once, so it's not allowed to assign menu items to the application menu multiple times.
Parameters
id |
Menu id, defines to which menu the plug-in will be added. Possible values:
Required. |
order |
The menu order, used to define the order of plug-in items (1, 2, 3, etc) as they appear in the menu. The actual order is a a result of all active plug-in order values combined. Required. |
Examples
Typical menu assignments for a plug-in that requires no selection
<menuAssignments>
<menuAssignment id="toolBar" order="1"/>
<menuAssignments>
Typical menu assignments for a plug-in that requires an asset selection
<menuAssignments>
<menuAssignment id="assetContextMenu" order="3"/>
<menuAssignment id="toolBar" order="3"/>
<menuAssignments>
Typical menu assignments for a plug-in that requires a folder selection
<menuAssignments>
<menuAssignment id="folderContextMenu" order="4"/>
<menuAssignment id="toolBar" order="2"/>
<menuAssignments>
Document history
- 16 April 2019: Removed references of the application menu and the applicationMenu option because it is not used by Elvis 6.
Comments
2 comments
Please list all available values for menuAssignment. Only 3 options are listed in “description” at the top of the article: ‘application menu’, ‘toolbar’, context menu of the file. But the last example introduces a new one: folderContextMenu. Are there any others available? And what are the ‘applicationMenu’ and ‘toolBar’ exactly, with regards to Elvis 6?
Hello Sergey,
'applicationMenu' and 'folderContextMenu' menu assignments are not used in Elvis 6
'toolBar' menu assignment places plugin on the top header panel (near search field)
Documentation will be updated
Please sign in to leave a comment.