MenuItem

MenuItem

MenuItem is a control which is added to Menu instances, or as a child of other MenuItems. MenuItems can be created automatically or explicitly when working with a Menu.

MenuItems in a Menu

Code Example: Creating MenuItems

The following code shows how to create menu items. Notice that MenuItems can be added to a Menu, or as children of other MenuItems.

// Initialize
var menu = new Menu();
menu.AddToRoot();

var fileMenuItem = new MenuItem();
fileMenuItem.Header = "File";
menu.Items.Add(fileMenuItem);

var newItem = new MenuItem();
newItem.Header = "New";
fileMenuItem.Items.Add(newItem);

var loadRecent = new MenuItem();
loadRecent.Header = "Load Recent";
fileMenuItem.Items.Add(loadRecent);

for(int i = 0; i < 10; i++)
{
    var item = new MenuItem();
    item.Header = "File " + i;
    loadRecent.Items.Add(item);
}

var editMenuItem = new MenuItem();
editMenuItem.Header = "Edit";
menu.Items.Add(editMenuItem);

Try on XnaFiddle.NET

IsSelected

IsSelected controls whether the MenuItem displays its Selected state. If this value is true, the MenuItem displays its contained Items.

Typically this property is set to true by clicking on a MenuItem, or by hovering over a MenuItem after its parent is selected, but it can also be explicitly set to true.

The following code shows how to explicitly set IsSelected to true based on keyboard input:

// Update
var keyboard = GumService.Default.Keyboard;

if(keyboard.IsAltDown)
{
    if(keyboard.KeyPushed(Microsoft.Xna.Framework.Input.Keys.F))
    {
        FileMenuItem.IsSelected = true;
    }
    else if(keyboard.KeyPushed(Microsoft.Xna.Framework.Input.Keys.E))
    {
        EditMenuItem.IsSelected = true;
    }
}

Try on XnaFiddle.NET

By default MenuItems in a Menu are not selected unless the user clicks on the MenuItem. Once an item is selected, the user can hover over any menu item (either in the Menu itself, or a child MenuItem) to automatically expand the MenuItem.

Handling Activation

MenuItem provides two events:

• Clicked fires when the user clicks a MenuItem. Use this to respond when the user picks a menu item.
• Selected fires when IsSelected becomes true, which also opens the MenuItem's submenu. This is useful for reacting to submenu expansion rather than user activation.

For leaf items (items with no children), Clicked is typically the event you want.

The following code shows how to handle Clicked on leaf MenuItems to update a label.

// Initialize
var statusLabel = new Label();
statusLabel.Y = 40;
statusLabel.AddToRoot();
statusLabel.Text = "Select a menu item...";

var menu = new Menu();
menu.AddToRoot();

var fileMenuItem = new MenuItem();
fileMenuItem.Header = "File";
menu.Items.Add(fileMenuItem);

var newItem = new MenuItem();
newItem.Header = "New";
newItem.Clicked += (_, _) => statusLabel.Text = "New clicked";
fileMenuItem.Items.Add(newItem);

var openItem = new MenuItem();
openItem.Header = "Open";
openItem.Clicked += (_, _) => statusLabel.Text = "Open clicked";
fileMenuItem.Items.Add(openItem);

var exitItem = new MenuItem();
exitItem.Header = "Exit";
exitItem.Clicked += (_, _) => statusLabel.Text = "Exit clicked";
fileMenuItem.Items.Add(exitItem);

Try on XnaFiddle.NET