Lua:Class:PopupMenu

{} Class

class PopupMenu : Menu

The PopupMenu class represents a context menu.

A popup menu is the menu that appears when showing the right-click context menu of a control. It can be created with createPopupMenu.

Inheritance

Class	Inherits From	Description
PopupMenu	Menu	Represents a context menu.
Menu	Component	Base class for menu objects.
Component	Object	Base class for components.
Object	None	Base class for Lua-exposed objects.

Creation

<> Lua API Reference

function createPopupMenu(owner) : PopupMenu

Creates a PopupMenu object.

Function Parameters

Parameter	Type	Description
owner	Component	The owner of the popup menu.

Returns

PopupMenu — The created popup menu object.

Properties

This class does not define additional properties.

Inherited properties are available through Menu, Component, and Object.

Methods

This class does not define additional methods.

Inherited methods are available through Menu, Component, and Object.

Examples

Create a PopupMenu

1 local form = createForm(false)
2 local popupMenu = createPopupMenu(form)
3 
4 form.PopupMenu = popupMenu
5 form.show()

Add menu items to a PopupMenu

 1 local form = createForm(false)
 2 local popupMenu = createPopupMenu(form)
 3 
 4 local menuItem = createMenuItem(popupMenu)
 5 menuItem.Caption = "Say hello"
 6 menuItem.OnClick = function(sender)
 7   print("Hello")
 8 end
 9 
10 popupMenu.Items.add(menuItem)
11 
12 form.PopupMenu = popupMenu
13 form.show()

Use a PopupMenu as a form context menu

 1 local form = createForm(false)
 2 local popupMenu = createPopupMenu(form)
 3 
 4 local closeItem = createMenuItem(popupMenu)
 5 closeItem.Caption = "Close"
 6 closeItem.OnClick = function(sender)
 7   form.close()
 8 end
 9 
10 popupMenu.Items.add(closeItem)
11 
12 form.PopupMenu = popupMenu
13 form.show()

Assign a PopupMenu to a control

 1 local form = createForm(false)
 2 local popupMenu = createPopupMenu(form)
 3 
 4 local button = createButton(form)
 5 button.Caption = "Right-click me"
 6 
 7 local menuItem = createMenuItem(popupMenu)
 8 menuItem.Caption = "Button action"
 9 menuItem.OnClick = function(sender)
10   print("Popup item clicked")
11 end
12 
13 popupMenu.Items.add(menuItem)
14 button.PopupMenu = popupMenu
15 
16 form.show()

Create multiple context actions

 1 local form = createForm(false)
 2 local popupMenu = createPopupMenu(form)
 3 
 4 local copyItem = createMenuItem(popupMenu)
 5 copyItem.Caption = "Copy"
 6 copyItem.OnClick = function(sender)
 7   print("Copy selected")
 8 end
 9 
10 popupMenu.Items.add(copyItem)
11 
12 local pasteItem = createMenuItem(popupMenu)
13 pasteItem.Caption = "Paste"
14 pasteItem.OnClick = function(sender)
15   print("Paste selected")
16 end
17 
18 popupMenu.Items.add(pasteItem)
19 
20 form.PopupMenu = popupMenu
21 form.show()

Create a PopupMenu for a memo

 1 local form = createForm(false)
 2 local popupMenu = createPopupMenu(form)
 3 
 4 local memo = createMemo(form)
 5 memo.Align = alClient
 6 
 7 local clearItem = createMenuItem(popupMenu)
 8 clearItem.Caption = "Clear"
 9 clearItem.OnClick = function(sender)
10   memo.Lines.clear()
11 end
12 
13 popupMenu.Items.add(clearItem)
14 memo.PopupMenu = popupMenu
15 
16 form.show()

Main Pages

Core Lua documentation entry points

◆ Lua
◆ Script Engine