This documentation is archived and is not being maintained.

Menu.MenuItemCollection.Remove Method

Removes the specified MenuItem from the menu item collection.

[Visual Basic]
Public Overridable Sub Remove( _
   ByVal item As MenuItem _
)
[C#]
public virtual void Remove(
 MenuItem item
);
[C++]
public: virtual void Remove(
 MenuItem* item
);
[JScript]
public function Remove(
   item : MenuItem
);

Parameters

item
The MenuItem to remove.

Remarks

When a MenuItem is removed from the menu item collection, all subsequent menu items are moved up one position in the collection. You can use this version of the Remove to remove a specific MenuItem from the collection using a reference to the MenuItem to be removed. If you do not have a reference to the MenuItem that you want to remove, you can use the other version of this method that accepts, as a parameter, an index corresponding to the MenuItem to be removed.

Example

[Visual Basic, C#, C++] In this example, you create a main menu, myMainMenu, with two MenuItem objects, File and Edit. The File menu has three submenu items, New, Open, and Exit. Using the Remove method, you remove the Open item from the File menu collection. This program assumes that you have already created a Form named Form1.

[Visual Basic] 
Public Sub InitializeMyMenu()
    ' Create the MainMenu object.
    Dim myMainMenu As New MainMenu()

    ' Create the MenuItem objects.
    Dim fileMenu As New MenuItem("&File")
    Dim editMenu As New MenuItem("&Edit")
    Dim newFile As New MenuItem("&New")
    Dim openFile As New MenuItem("&Open")
    Dim exitProgram As New MenuItem("E&xit")

    ' Add the MenuItem objects to myMainMenu.
    myMainMenu.MenuItems.Add(fileMenu)
    myMainMenu.MenuItems.Add(editMenu)

    ' Add three submenus to the File menu.
    fileMenu.MenuItems.Add(newFile)
    fileMenu.MenuItems.Add(openFile)
    fileMenu.MenuItems.Add(exitProgram)

    ' Assign myMainMenu to the form.
    Menu = myMainMenu

    ' Remove the item "Open" from the File menu.
    fileMenu.MenuItems.Remove(openFile)
End Sub 'InitializeMyMenu

[C#] 
public void InitializeMyMenu()
{
    // Create the MainMenu object.
    MainMenu myMainMenu = new MainMenu();
    
    // Create the MenuItem objects.
    MenuItem fileMenu = new MenuItem("&File");
    MenuItem editMenu = new MenuItem("&Edit");
    MenuItem newFile = new MenuItem("&New");
    MenuItem openFile = new MenuItem("&Open");
    MenuItem exitProgram = new MenuItem("E&xit");
    
    // Add the MenuItem objects to myMainMenu.
    myMainMenu.MenuItems.Add(fileMenu);
    myMainMenu.MenuItems.Add(editMenu);

    // Add three submenus to the File menu.
    fileMenu.MenuItems.Add(newFile);
    fileMenu.MenuItems.Add(openFile);
    fileMenu.MenuItems.Add(exitProgram);

    // Assign myMainMenu to the form.
    Menu = myMainMenu;

    // Remove the item "Open" from the File menu.
    fileMenu.MenuItems.Remove(openFile);
}

[C++] 
public:
    void InitializeMyMenu() {
        // Create the MainMenu object.
        MainMenu* myMainMenu = new MainMenu();

        // Create the MenuItem objects.
        MenuItem* fileMenu = new MenuItem(S"&File");
        MenuItem* editMenu = new MenuItem(S"&Edit");
        MenuItem* newFile = new MenuItem(S"&New");
        MenuItem* openFile = new MenuItem(S"&Open");
        MenuItem* exitProgram = new MenuItem(S"E&xit");

        // Add the MenuItem objects to myMainMenu.
        myMainMenu->MenuItems->Add(fileMenu);
        myMainMenu->MenuItems->Add(editMenu);

        // Add three submenus to the File menu.
        fileMenu->MenuItems->Add(newFile);
        fileMenu->MenuItems->Add(openFile);
        fileMenu->MenuItems->Add(exitProgram);

        // Assign myMainMenu to the form.
        Menu = myMainMenu;

        // Remove the item S"Open" from the File menu.
        fileMenu->MenuItems->Remove(openFile);
    }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

Menu.MenuItemCollection Class | Menu.MenuItemCollection Members | System.Windows.Forms Namespace

Show: