This documentation is archived and is not being maintained.

Menu.MenuItemCollection.Add Method (Int32, MenuItem)

.NET Framework 1.1

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

[Visual Basic]
Overloads Public Overridable Function Add( _
   ByVal index As Integer, _
   ByVal item As MenuItem _
) As Integer
[C#]
public virtual int Add(
 int index,
 MenuItem item
);
[C++]
public: virtual int Add(
 int index,
 MenuItem* item
);
[JScript]
public function Add(
   index : int,
 item : MenuItem
) : int;

Parameters

index
The position to add the new item.
item
The MenuItem to add.

Return Value

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

Exceptions

Exception Type Condition
Exception The MenuItem being added is already in use.
ArgumentException The index supplied in the index parameter is larger than the size of the collection.

Remarks

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.

Example

[Visual Basic, C#, C++] The following 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 assumes that the method defined in this example is located within the class for a form and called by a method in that form class.

[Visual Basic] 
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


[C#] 
private void InitializeMyMainMenu()
{
   // Create the MainMenu and the MenuItem to add.
   MainMenu mainMenu1 = new MainMenu();
   MenuItem menuItem1 = 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.
   this.Menu = mainMenu1;
}


[C++] 
private:
 void InitializeMyMainMenu()
 {
    // Create the MainMenu and the MenuItem to add.
    MainMenu* mainMenu1 = new MainMenu();
    MenuItem* menuItem1 = new MenuItem(S"&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.
    this->Menu = mainMenu1;
 }
 

[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

See Also

Menu.MenuItemCollection Class | Menu.MenuItemCollection Members | System.Windows.Forms Namespace | Menu.MenuItemCollection.Add Overload List | Remove

Show: