Logo Help Center

Action plug-in setting - menuAssignments

Elvis 5 action plug-ins setting - menuAssignments

(5) Required setting

Controls from which menu(s) the plug-in is available, this can be combination of the following:

  • application menu
  • main button toolbar
  • file context menu
  • folder context menu

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.

<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.
  • folderContextMenu - adds a sub item to the plug-in menu in the folder context menu. Add this menu assignment when the plug-in requires a folder 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.

Application menu - id="applicationMenu"

The application menu

Asset context menu - id="assetContextMenu"

The context menu

Folder context menu - id="folderContextMenu"

The folder context menu

Main button toolbar - id="toolBar"

The toolbar

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>
Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.