Controls whether this menu item displays a checkmark.

An arbitrary data object associated with this menu item.

You can assign any object to this property. The assigned object is not used by the menu system, but is available to event handling code (through the target property of the event object). By default, the value of this property is null.

Controls whether this menu item is enabled.

Reports whether this item is a menu separator line.

Create a separator line by setting the isSeparator parameter in the NativeMenuItem constructor to true.

The key equivalent for this menu item.

Set the keyEquivalent with a lowercase letter to assign a shortcut without a Shift-key modifier. Set with an uppercase letter to assign a shortcut with the Shift-key modifier.

By default, a key equivalent modifier (Ctrl on Windows or Linux and Command on Mac OS X) is included as part of the key equivalent. If you want the key equivalent to be a key with no modifier, set the keyEquivalentModifiers property to an empty array.

The array of key codes for the key equivalent modifiers.

Use the constants defined in the Keyboard class to specify the modifier key codes. Valid modifier keys include:

• Keyboard.ALTERNATE
• Keyboard.COMMAND
• Keyboard.CONTROL

If you do not assign any modifiers, then by default the Keyboard.CONTROL key is assigned on Windows or Linux and the Keyboard.COMMAND key is assigned on Mac OS X. If you do not want the key equivalent to include these modifiers, set this property to an empty array.

If you assign an uppercase letter to the keyEquivalent property, the Shift key is used as a modifier automatically. Setting keyEquivalentModifier to an empty array does not remove the Shift key as a modifier.

Related API Elements

The display string of this menu item.

The menu that contains this item.

The position of the mnemonic character in the menu item label.

The character at the specified position is the mnemonic character for the menu item. The index is zero-based, so the first character has an index of 0.

This property is ignored on operating systems that do not use menu mnemonics.

The name of this menu item.

The name value is not displayed and can be used as a locale-independent identifier. A name is not assigned automatically.

The submenu associated with this menu item.

Assigning a NativeMenu object to this property changes the appearance and behavior of the menu item. A submenu item displays the submenu icon and no longer dispatches select events.

Note: Adding a menu as a submenu of itself (in a circular reference) can cause an application to hang.

Related API Elements

Creates a new NativeMenuItem object.

To create a menu command, set the label parameter to a string containing the display label and set isSeparator to false.

To create a submenu command, create a command item and then assign the NativeMenu object for the submenu to the item's submenu property. Add the item to the parent menu.

To create a separator, set the label parameter to an empty string and set isSeparator to true.

Add and remove items from a menu using the NativeMenu addItem() and removeItem() methods.

Related API Elements

Creates a copy of the NativeMenuItem object.

Returns a string containing all the properties of the NativeMenuItem object.

Dispatched by this NativeMenuItem object immediately before the menu containing the item is displayed.

The preparing event supersedes the displaying event and provides additional functionality. Listen for the preparing event or the displaying event, but not both.

Note: This event does not go through a "capture phase" and is dispatched directly to the target, whether the target is on the display list or not.

This event has the following properties:

Dispatched by this NativeMenuItem object when its key equivalent is pressed and immediately before the containing menu is displayed.

Listen to this event to update the item either before the containing menu is displayed, or when its key equivalent is pressed by the user. The preparing event is dispatched before the key equivalent is fully evaluated. You can enable, disable, or remove the item from the menu in the preparing event handler and those changes will be in effect when the key equivalent is processed. For example, if you remove or disable this menu item, then the sequence of events is effectively canceled and no select event is dispatched. A preparing event is also dispatched by the other items in a menu.

The preparing event supersedes the displaying event and provides additional functionality. Listen for the preparing event or the displaying event, but not both.

Note: This event does not go through a "capture phase" and is dispatched directly to the target, whether the target is on the display list or not.

This event has the following properties:

Dispatched whenever a menu item is selected by the user.

A select event bubbles from this item to its containing menu and on up through the parent menu chain to the root menu object. The target property of the event object references this NativeMenuItem object; the currentTarget property references the dispatching object (either this NativeMenuItem or an ancestral NativeMenu object).

Note: If the window containing the menu is in fullscreen mode (stage.displayState == StageDisplayState.FULL_SCREEN), the NativeMenuItem object does not dispatch a select event when the user enters a keyboard equivalent for a menu item.

This event has the following properties: