Skip to main content

Introduction

This component provides graphic menus.

"UI Menu"

Fields#

NameDescription
Auto Select First ItemAutomatically select the first item on start
Context MenuDisplay as a context menu
Menu NavNavigation Details
Submit ButtonButton to submit selected item
Cancel ButtonButton to cancel out of menu
Submit KeyKey to submit selected item
Cancel KeyKey to cancel out of menu
Hide DisabledHide items that are disabled
Can CancelAllow canceling from menu
Is Modal MenuMake menu modal
Auto Set ModalAutomatically set modal mode
Dialog IdID to associate with menu in modal mode
Audio SourceComponent used to play audio
Change SelectionSound to play on selection change
SubmitSound to play on item submit
CancelSound to play on cancel
On Selection ChangedEvent raised when selection changes
On CancelEvent raised when canceling
On Selected Index ChangedEvent raised when selected index changes
On DisabledEvent raised when menu is disabled

Properties#

NameDescription
activeChildMenuActive child menu.
destroyOnCloseGets/Sets if this object should destroy itself on close.
parentGets/Sets the control that this is a sub-menu of.
selectedIndexGets/Sets the currently selected index
selectedItemGets/Sets the currently selected item

Methods#

NameDescription
CloseClose the menu
NextItemSelect the next item in the list.
OpenSubMenuOpen another menu as a sub-menu of this one.
PreviousItemSelect the previous item in the list.
RegisterMenuItemRegister a menu item as a child of this menu.