4D Doc Center : Dynamic pop up menu

Home

4D v14.3

Dynamic pop up menu


Dynamic pop up menu ( menu {; default {; xCoord ; yCoord}} ) -> Function result

Parameter	Type	Description
menu	MenuRef	Menu reference
default	String	Parameter of item selected by default
xCoord	Longint	X coordinate of top left corner
yCoord	Longint	Y coordinate of top left corner
Function result	String	Parameter of selected menu item

Description

The Dynamic pop up menu causes a hierarchical pop-up menu to appear at the current location of the mouse or at the location set by the optional xCoord and yCoord parameters.

The hierarchical menu used must have been created using the Create menu command. The reference returned by Create menu must then be passed in the menu parameter.

In conformity with standard interface rules, this command must generally be called in response to a right mouse click or when the button is held down a certain period of time (context menu for example).

The optional default parameter can be used to set an item of the popup menu as selected by default whenever the menu appears. In this parameter, pass a custom string associated with the menu item. This string must have been set beforehand using the SET MENU ITEM PARAMETER command. If you do not pass this parameter, the first item of the menu will be selected by default.

The optional xCoord and yCoord parameters can be used to specify the location of the pop-up menu to be displayed. In the xCoord and yCoord parameters, pass the horizontal and vertical coordinates, respectively, of the top left corner of the menu. These coordinates must be expressed in pixels in the local coordinate system of the current form. Both parameters must be passed together; if only one of them is passed, it will be ignored.

If you want to display a pop-up menu associated with a 3D button, then do not pass the optional xCoord and yCoord parameters. In this case, 4D automatically calculates the location of the menu with respect to the button according to the interface standards of the current platform.

If a menu item has been selected, the command returns its associated custom character string (such as it has been defined using the SET MENU ITEM PARAMETER command). Otherwise, the command returns an empty string.

Note: The existing Pop up menu command (“User Interface” theme) can be used to create pop-up menus based on text.