Popup Menu (PRIM_PPNL.Menu)

Popup Menu

Ancestors - Popup (PRIM_PPNL)Panel (PRIM_PANL)Container (PRIM_CPST)Control (PRIM_CTRL)Object (PRIM_OBJT)

Details

A Popup Menu is used for both right click context menus and submenus from Menu Bar and Menu Item
 
Popup Menu is a composite control and as such can contain any other controls. However, to simplify the construction, all child controls will flow down the menu item, fitting to the width.
 
Popup Menu can be used to add a context menu to a control simply by dropping one in the designer. If dropped on a Push Button it will become the drop menu for the button. If dropped on a menu item it will become submenu.
 
A Popup Panel can be used instead of a Popup Menu to provide a free format menu area.
 
The Prepare is fired immediately before the menu is displayed.

Example

This example shows a button with an attached popup menu. The second item in the popup has submenu showing 2 further items.
 
Construction of menus is easily managed in the designer. This code is provided for reference purposes.
Begin_Com Role(*EXTENDS #PRIM_WEB)
 
   Define_Com Class(#PRIM_PHBN) Name(#Button) Caption('Button') Displayposition(2) Left(560) Parent(#COM_OWNER) Tabposition(1) Top(40) Width(145) Menupopup(#PopupMenu1)
 
   Define_Com Class(#PRIM_PPNL.Menu) Name(#PopupMenu1) Left(8) Top(33) Height(104)
   Define_Com Class(#PRIM_PPNL.MenuItem) Name(#MenuItem1) Caption('MenuItem1') Displayposition(1) Parent(#PopupMenu1) Tabposition(1) Tabstop(False) Width(148)
   Define_Com Class(#PRIM_PPNL.MenuItem) Name(#MenuItem2) Caption('MenuItem2') Displayposition(2) Parent(#PopupMenu1) Tabposition(4) Tabstop(False) Top(25) Width(148) Menupopup(#PopupMenu2)
   Define_Com Class(#PRIM_PPNL.MenuItem) Name(#MenuItem3) Caption('MenuItem3') Displayposition(3) Parent(#PopupMenu1) Tabposition(3) Tabstop(False) Top(50) Width(148)
   Define_Com Class(#PRIM_PPNL.MenuItem) Name(#MenuItem4) Caption('MenuItem4') Displayposition(4) Parent(#PopupMenu1) Tabposition(2) Tabstop(False) Top(75) Width(148)
 
   Define_Com Class(#PRIM_PPNL.Menu) Name(#PopupMenu2) Left(157) Top(59) Height(54)
   Define_Com Class(#PRIM_PPNL.MenuItem) Name(#MenuItem5) Caption('MenuItem1') Displayposition(1) Parent(#PopupMenu2) Tabposition(1) Tabstop(False)
   Define_Com Class(#PRIM_PPNL.MenuItem) Name(#MenuItem6) Caption('MenuItem2') Displayposition(2) Parent(#PopupMenu2) Tabposition(2) Tabstop(False)
 
End_Com

Properties

Name Description
AutoClose Close the panel automatically Inherited from Popup (PRIM_PPNL)
AutoFocus Set to true to set focus to the popup panel when shown Inherited from Popup (PRIM_PPNL)
BusyUpdates BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL)
BusyUpdatesOfParent BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL)
CanFocus CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL)
Caption Text to display in the title bar Inherited from Popup (PRIM_PPNL)
CloseButton Show the close button in the title bar Inherited from Popup (PRIM_PPNL)
CloseImage Repository enrolled image to show in the title bar Inherited from Popup (PRIM_PPNL)
CloseOnClick Set to True to close the popup when on click of a child control Inherited from Popup (PRIM_PPNL)
ComponentClassName ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentControls ComponentControls is a collection of all the controls contained in this component. Inherited from Container (PRIM_CPST)
ComponentMembers ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternName ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTag Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentType ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeName ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
Content Panel to show in the popup Inherited from Popup (PRIM_PPNL)
Cursor Cursor sets the cursor image Inherited from Control (PRIM_CTRL)
DesignManager Reference to a Design Manager instance for this panel Inherited from Panel (PRIM_PANL)
DisableNoScroll DisableNoScroll controls whether scroll bars are displayed. Inherited from Panel (PRIM_PANL)
DisplayPosition DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL)
DragStyle DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL)
EnableChildren EnableChildren specifies if the parent sets the Enabled property of child components Inherited from Container (PRIM_CPST)
Enabled Enable activates/deactivates the component Inherited from Control (PRIM_CTRL)
FixedPosition Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL)
Focus Focus tells whether the component has focus Inherited from Control (PRIM_CTRL)
FocusedStyle Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusedStyles Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL)
Handle Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL)
Height The height of the control in pixels Inherited from Control (PRIM_CTRL)
Hint Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL)
HintPopup HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL)
HintShow Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL)
HintShowOfParent Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL)
HintTitle HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL)
HorizontalScroll Show the horizontal scroll bar Inherited from Panel (PRIM_PANL)
HorizontalScrollInc HorizontalScrollInc specifies the pixel increment for horizontal scroll bar. Inherited from Panel (PRIM_PANL)
HorizontalScrollPos HorizontalScrollPos sets the position of the horizontal scroll bar Inherited from Panel (PRIM_PANL)
HorizontalScrollRemainder Specifies the pixels remaining to the right of the current scroll position Inherited from Panel (PRIM_PANL)
Image Repository enrolled image to show in the control Inherited from Panel (PRIM_PANL)
ImageAlignment Position of the image within the panel Inherited from Panel (PRIM_PANL)
IsAnimating IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL)
IsOpen Returns True if the popup is currently being shown Inherited from Popup (PRIM_PPNL)
IsRealized True if the control is currently realized Inherited from Control (PRIM_CTRL)
LayoutManager Reference to a layout manager used to control the position of child controls Inherited from Panel (PRIM_PANL)
Left Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL)
MenuSizing Controls whether the menu will be sized as designed or to the size of the menu items
Modified Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL)
MouseOver MouseOver determines whether the mouse is directly over a control Inherited from Popup (PRIM_PPNL)
MouseOverPart True if the cursor is within the bounds of a child component Inherited from Popup (PRIM_PPNL)
MouseOverStyle MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
MouseOverStyles MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
Name Name identifies the component Inherited from Object (PRIM_OBJT)
Opacity Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL)
Owner Owner owns this component Inherited from Object (PRIM_OBJT)
Parent Reference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL)
Popup Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL)
PopupMenu Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL)
PrivateStyle Style applied to the control but not inherited by child controls Inherited from Container (PRIM_CPST)
PrivateStyles Collection of styles applied to the control but not inherited by child controls Inherited from Container (PRIM_CPST)
RenderStyle Render content as DirectX or defer to the parent control Inherited from Panel (PRIM_PANL)
Rotation Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL)
RotationOriginLeft RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RotationOriginTop RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
ScaleHeight ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScaleOriginLeft ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleOriginTop ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleWidth ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScreenLeft ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL)
ScreenTop ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL)
ScrollLeft Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
ScrollTop Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
ShroudStyle Reference to a style to be used as a background when the popup is shown Inherited from Popup (PRIM_PPNL)
ShroudStyles Collection of styles to be used as a background when the popup is shown Inherited from Popup (PRIM_PPNL)
SkewLeft SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL)
SkewOriginLeft SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewOriginTop SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewTop SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL)
Style Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL)
Styles Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL)
TabPosition TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL)
TabStop Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL)
ThemeBackground Themed background for Material Design themed applications Inherited from Panel (PRIM_PANL)
ThemeDrawStyle Name of the Theme DrawStyle to be applied to the panel Inherited from Panel (PRIM_PANL)
ThemeStyle Specifies how theme usage is determined Inherited from Panel (PRIM_PANL)
TitleBar Show the title bar Inherited from Popup (PRIM_PPNL)
TitleBarThemeDrawStyle Name of the Theme DrawStyle to be applied to the title bar Inherited from Popup (PRIM_PPNL)
TitleImage Image displayed on the left side of the title bar Inherited from Popup (PRIM_PPNL)
Top Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL)
TouchMove Determines how the popup panel will respond to touch move processing Inherited from Popup (PRIM_PPNL)
TouchRotate Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL)
TouchScale Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL)
TouchSize Determines whether a popup panel can be resized Inherited from Popup (PRIM_PPNL)
VerticalScroll Show the vertical scroll bar Inherited from Panel (PRIM_PANL)
VerticalScrollInc VerticalScrollInc specifies the pixel increment for vertical scroll bar. Inherited from Panel (PRIM_PANL)
VerticalScrollPos VerticalScrollPos sets the position of the vertical scroll bar Inherited from Panel (PRIM_PANL)
VerticalScrollRemainder Specifies the pixels left to the botom from the current scroll position Inherited from Panel (PRIM_PANL)
Visible Show or hide the control Inherited from Control (PRIM_CTRL)
VisualStyle VisualStyle sets the appearance Inherited from Control (PRIM_CTRL)
VisualStyleOfParent Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL)
Width Width of the component in pixels Inherited from Control (PRIM_CTRL)

Events

Name Description
AnimationEnded Fired when an animation is ended Inherited from Control (PRIM_CTRL)
Cancelled
Click Fired when the mouse is clicked on the control Inherited from Control (PRIM_CTRL)
Origin, Handled
Closed The popup panel has closed Inherited from Control (PRIM_CTRL)
Closing The popup is closing Inherited from Control (PRIM_CTRL)
ClosePopup
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from Control (PRIM_CTRL)
DesignChanged Fired when the a design is activated Inherited from Control (PRIM_CTRL)
Design, DesignManager
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Control (PRIM_CTRL)
DoubleClick Fired when the user double clicks Inherited from Control (PRIM_CTRL)
Origin, Handled
DragDrop Fired on mouse up to signify the end of a drag process Inherited from Control (PRIM_CTRL)
PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult
DragOver Fired during the drag and drop process when the cursor moves over the control Inherited from Control (PRIM_CTRL)
PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled
EndDrag Fired when the drag and drop process has completed Inherited from Control (PRIM_CTRL)
Source, Payload, DragResult, AggregatedSource, Origin, Handled
Enter Fired when the Enter key is pressed Inherited from Control (PRIM_CTRL)
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
Initialize Fired after a component has been realized for the first time Inherited from Control (PRIM_CTRL)
KeyPress Fired when a key is pressed on the keyboard Inherited from Control (PRIM_CTRL)
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
MouseEnter The mouse has entered the bounds of the control Inherited from Control (PRIM_CTRL)
MouseHover The mouse has hovered over the control Inherited from Control (PRIM_CTRL)
Origin, Handled
MouseLeave The mouse has left the bounds of the control Inherited from Control (PRIM_CTRL)
Prepare Popup is about to be shown Inherited from Control (PRIM_CTRL)
Context, Left, Top, Width, Height, Transition, Continue
ScrollChanged Fired when the scrollbars in a composite control are moved Inherited from Control (PRIM_CTRL)
Orientation
SizeChanged Fired when the size of the panel is changed Inherited from Control (PRIM_CTRL)
StartDrag Fired when the user starts a drag and drop process Inherited from Control (PRIM_CTRL)
Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled
TouchChange Fired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events Inherited from Control (PRIM_CTRL)
MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue
TouchEnd Fired when the user stops touching the screen Inherited from Control (PRIM_CTRL)
TouchStart Fired when the user first makes physical contact with the screen Inherited from Control (PRIM_CTRL)
Origin, TouchMove, TouchRotate, TouchScale, TouchSize

Methods

Name Description
ClosePopup Close the popup Inherited from Popup (PRIM_PPNL)
FadeIn Animate from invisible to visible Inherited from Control (PRIM_CTRL)
Duration, Delay
FadeOut Animate from visible to invisible Inherited from Control (PRIM_CTRL)
Duration, Delay, Visible
HorizontalScrollTo Set the horizontal scroll position using a child control Inherited from Panel (PRIM_PANL)
Control, ScrollPosition
MoveFrom Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
MoveTo Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
Realize Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
Scale Animate a change of scale Inherited from Control (PRIM_CTRL)
ScaleWidth, ScaleHeight, Duration, Delay
SetFocus Sets the control to be the focus control Inherited from Control (PRIM_CTRL)
ShowMessages LANSA Internal Use Inherited from Control (PRIM_CTRL)
ShowPopup Show the popup Inherited from Popup (PRIM_PPNL)
Left, Top, Placement, Transition, Context
SizeTo Changes and animates control size changing Inherited from Control (PRIM_CTRL)
Width, Height, Duration, Delay
Transition Animate the change from one control to another Inherited from Container (PRIM_CPST)
From, To, TransitionType, Duration, Delay
Unrealize Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
UpdateDisplay UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL)
VerticalScrollTo Set the vertical scroll position using a child control Inherited from Panel (PRIM_PANL)
Control, ScrollPosition

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020