Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added a ligne of ___ under type= in the table to fix 1st column width

...

String ElementDescription

type=<element type>

__________________________

Specifies the type of menu item. Supported types are:

"separator" -

The menu item will be a separator (divider). Other parameters will be ignored.

"menu" -

The menu item will pop up a sub menu when selected. The sub menu will be populated with the elements corresponding to the string array returned by a procedure defined by the `itemsproc' parameter.

"aov" -

The menu item is an AOV. The actual full declaration of the AOV must be specified by the varname parameter. If a label parameter is specified, it will be used to define this menu item's text label. If no label is specified, the correct element from DL_userGetAllDisplayAOVs will be used whenever possible. The varname is used as a label as a last resort.

label=<label string>

Specifies the label to use for this menu item.

itemsproc=<procedure name>Specified the name of a procedure to populate a sub menu. Only relevant when specified along with type=menu. The procedure is expected to take no arguments and return a string array listing the needed menu items.
varname=<aov name>Specifies the full declaration of the AOV. This declaration is when will be set in the display's Output Variable text field. It should be identical to an element of DL_userGetAllDisplayAOVDeclarations if the menu item's label is to be determined automatically using DL_userGetAllDisplayAOVs and to allow correct AOV identification in the display's frame layout label in the Attribute Editor.
varindex=<index>Specifies the index of the arrays returned by DL_userGetAllDisplayAOVs and DL_userGetAllDisplayAOVDeclarations that should be used to determine the aov name and declaration, respectively.