Add Method (Int32, MenuItem)
Collapse the table of content
Expand the table of content

Menu.MenuItemCollection.Add Method (Int32, MenuItem)


Adds a previously created MenuItem at the specified index within the menu item collection.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

Public Overridable Function Add (
	index As Integer,
	item As MenuItem
) As Integer


Type: System.Int32

The position to add the new item.

Type: System.Windows.Forms.MenuItem

The MenuItem to add.

Return Value

Type: System.Int32

The zero-based index where the item is stored in the collection.

Exception Condition

The MenuItem being added is already in use.


The index supplied in the index parameter is larger than the size of the collection.

A MenuItem can only be contained in one menu at a time, and cannot be added more than once to the same menu. To reuse a MenuItem in more than one menu, use the CloneMenu method of the MenuItem class. To remove a MenuItem that you have previously added, use the Remove method.

This version of the Add method allows you to add previously created MenuItem objects to a specific index location within the collection. Any MenuItem currently located at that index, and all MenuItem objects after that index, are moved to the next lowest index in the collection.

The following code example creates an instance of the derived class, MainMenu, and adds a MenuItem object to its collection of MenuItem objects at a specific location in the menu item collection. This example requires that the method defined in this example is located within the class for a form and called by a method in that form class.

Private Sub InitializeMyMainMenu()
    ' Create the MainMenu and the MenuItem to add.
    Dim mainMenu1 As New MainMenu()
    Dim menuItem1 As New MenuItem("&File")

    ' Use the MenuItems property to call the Add method
    ' to add the MenuItem to mainMenu1 at specific index. 
    mainMenu1.MenuItems.Add(0, menuItem1)

    ' Assign mainMenu1 to the form.
    Me.Menu = mainMenu1
End Sub

.NET Framework
Available since 1.1
Return to top
© 2016 Microsoft