Avatar
Documentation Team
  • Created:
  • Updated:
Follow

Elvis 6 action plug-ins setting - menuAssignments

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:

  • The application menu
  • the main button toolbar
  • The context menu of a file

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 
<action>
    <menuAssignments>
                <menuAssignment>...</menuAssignment> 
        </menuAssignments>
</action>

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:

  • applicationMenu - adds a sub item to the plug-in menu in the main application menu. Required when there are also keyBindings assigned to your plug-in.
  • assetContextMenu - adds a sub item to the plug-in menu in the asset context menu. Add this menu assignment when the plug-in requires an asset selection.
  • toolBar - adds a button in the application's main button toolbar.

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="applicationMenu" order="1"/>
    <menuAssignment id="toolBar" order="1"/>
<menuAssignments>

Typical menu assignments for a plug-in that requires an asset selection

<menuAssignments>
    <menuAssignment id="applicationMenu" order="3"/>
    <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="applicationMenu" order="1"/>
    <menuAssignment id="folderContextMenu" order="4"/>
    <menuAssignment id="toolBar" order="2"/>
<menuAssignments>

Document history

  • 29 January 2019: Removed references to the context menu of folders.

Comments

2 comments

Sort by Date Votes
  • Avatar
    Sergey Golikov

    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?

    1
    Permalink
  • Avatar
    Oleksiy Cherkasov

    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

    0
    Permalink

Please sign in to leave a comment.

In this article

      Tags:

    Other articles in this section

    See more

    Related articles