Prev Next

GetMenuList

Inputs

Parameter

Details

parameters

  • C++: const char*
  • C#: string

A JSON string of parameters. Includes:

  • level - the level hierarchy of the requested menu (starting with 1 for first level)
  • currentID, currentName - the ID and name of the current menu level
  • levelXID - the id of the menu level X for all previous levels in the hierarchy; that is, level1ID, level2ID
  • levelXName - the name of the menu level X for all previous levels in the hierarchy; that is level1Name, level2Name

Outputs via Callbacks

  • AddProperty - 2 calls per menu item: "id", "name".
  • [Optional] LogMessage or SetError - to provide user feedback.

Details

This method receives a request to populate the menu in the External Data window. Each level in the menu hierarchy will trigger a new request, and the parameters will include the level being requested.

This method should fill in the menu items by calling the AddProperty callback method.

Each item in the menu requires two calls to AddProperty. Each item must use a unique 'index' value as the first parameter.

  • id - the id passed in specifies a unique id representing this menu item; the Plug-in could receive this id back in subsequent calls (such as when requesting the next sub-menu level)
  • name - the user-displayable name of the menu item

Don't return an error for a blank response. Simply do nothing.