What is Incisor?
Tutorials
Key Concepts
Reddit
Stack Overflow
Deprecation Schedule

UiMenuItem()

A ui-specialized object with the components that comprise a menu item option within a UiMenu. UI functionality includes: • pre-configured with LayoutObject functionality. • uiStyle TextFormats and Colors applied. • pre-configured with 'UiKeyboardNavigable' functionality. • uiZoom-enabled. [REQUIREMENT: optional code module - 'extendedUi'] [NON-INSTANTIABLE]

new UiMenuItem()
IncisorAPI.js, line 13206

MEMBERS

leftIconGraphicAsset :GraphicAsset
IncisorAPI.js, line 13225

The GraphicAsset for an optional icon to show on the left side of the UiMenuItem.

leftIconGraphicObject :GraphicObject
IncisorAPI.js, line 13237

The read-only GraphicObject for the optional icon to show on the left side of the UiMenuItem.

leftIconScaleFactor :number
IncisorAPI.js, line 13231

The scale factor for the optional icon to show on the left side of the UiMenuItem. Use this property instead of directly scaling the GraphicObject to preserve UiZoom and LayoutObject functionality.

mainButton :UiPanel
IncisorAPI.js, line 13219

The main Button for the UiMenu for each UiMenuItem.

The main item showing in the UiMenu for each UiMenuItem. For all UiMenuItems except the searchBarMenuItem, this object is of type TextBox.

name :string
IncisorAPI.js, line 13262

The main string shown in the UiMenu for this UiMenuItem.

rightIconGraphicAsset :GraphicAsset
IncisorAPI.js, line 13243

The GraphicAsset for an optional icon to show on the right side of the UiMenuItem.

readonly rightIconGraphicObject :GraphicObject
IncisorAPI.js, line 13256

The read-only GraphicObject for the optional icon to show on the right side of the UiMenuItem.

rightIconScaleFactor :number
IncisorAPI.js, line 13249

The scale factor for the optional icon to show on the right side of the UiMenuItem. Use this property instead of directly scaling the GraphicObject to preserve UiZoom and LayoutObject functionality.

secondaryString :string
IncisorAPI.js, line 13268

The secondary string shown in the UiMenu on the right side of this UiMenuItem.

readonly secondaryTextBox :TextBox
IncisorAPI.js, line 13275

The read-only TextBox for the optional secondary text to show on the right side of the UiMenuItem.

If this UiMenuItem opens a sub-menu, then this property will be populated a reference to thed associated UiMenu, otherwise it will be undefined.

triggeringClosesMenu :boolean
IncisorAPI.js, line 13282

Boolean determining if triggering this UiMenuItem automatically closes the menu.

Default Value:
  • true

METHODS

dispose()
IncisorAPI.js, line 13295

Disposes the UiMenuItem and all of its components