Menu.MenuItemCollection.RemoveAt(Int32) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Removes a MenuItem from the menu item collection at a specified index.

public:
 virtual void RemoveAt(int index);

public virtual void RemoveAt(int index);

abstract member RemoveAt : int -> unit
override this.RemoveAt : int -> unit

Public Overridable Sub RemoveAt (index As Integer)

Parameters

index: Int32

The index of the MenuItem to remove.

Implements

RemoveAt(Int32)

Examples

The following code example shows how to create a main menu, myMainMenu, with two MenuItem objects, File and Edit. The File menu has three submenu items: New, Open, and Exit. By using the RemoveAt method, you remove the Exit item from the File menu collection using its index number. This example requires that you have already created a Form named Form1.

void InitializeMyMenu()
{
   // Create the MainMenu object.
   MainMenu^ myMainMenu = gcnew MainMenu;

   // Create the MenuItem objects.
   MenuItem^ fileMenu = gcnew MenuItem( "&File" );
   MenuItem^ editMenu = gcnew MenuItem( "&Edit" );
   MenuItem^ newFile = gcnew MenuItem( "&New" );
   MenuItem^ openFile = gcnew MenuItem( "&Open" );
   MenuItem^ exitProgram = gcnew 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 S"Exit" from the File menu.
   fileMenu->MenuItems->RemoveAt( 2 );
}

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 "Exit" from the File menu. 
    fileMenu.MenuItems.RemoveAt(2);
}

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 "Exit" from the File menu. 
   fileMenu.MenuItems.RemoveAt(2)
End Sub

Remarks

When a MenuItem is removed from the menu item collection, all subsequent menu items are moved up one position in the collection.

Applies to

Product	Versions
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0

Share via