MenuDataProvider.removeMenuItemAt()

Availability

Flash Player 6 (6.0.79.0).

Edition

Flash MX Professional 2004.

Usage

myMenuDataProvider.removeMenuItemAt(index)

Parameters

index The index of the menu item.

Returns

A reference to the removed menu item. This value is undefined if there is no item in that position.

Description

Method; removes the child item of the menu item specified by the index parameter. If there is no menu item at that index, calling this method has no effect.

Any node or menu item in a MenuDataProvider instance can call the methods of the MenuDataProvider class.

Example

The following example creates a menu with three menu items and, after an interval of a couple of seconds (2000 milliseconds), calls removeMenuItemAt() to remove the first menu item.

You first drag a Menu component to the library and then add the following code to Frame 1:

/**
 Requires:
  - Menu component in library
*/

import mx.controls.Menu;

// Create an XML object to act as a factory.
var my_xml:XML = new XML();

// The item created next does not appear in the menu.
// The createMenu() method call (below) expects to
// receive a root element whose children will become
// the items. This is just a simple way to create that
// root element and give it a convenient name.
var menuDP_obj:Object = my_xml.addMenuItem("XXXXX");

// Add the menu items.
menuDP_obj.addMenuItem({label:"1st Item"});
menuDP_obj.addMenuItem({label:"2nd Item"});
menuDP_obj.addMenuItem({label:"3rd Item"});

// Create the Menu object.
var my_menu:Menu = Menu.createMenu(this, menuDP_obj);

// Show and position the menus.
my_menu.show(100, 20);
// Call removeItem after 2000 milliseconds.
var interval_id:Number = setInterval(removeItem, 2000, my_menu);
function removeItem(the_menu:Menu):Void {
    // Remove the item at position 0.
    menuDP_obj.removeMenuItemAt(0);
    clearInterval(interval_id);
}