Menu::MenuItemCollection::IndexOf Method (MenuItem^)

 

Retrieves the index of a specific item in the collection.

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

public:
int IndexOf(
	MenuItem^ value
)

Parameters

value
Type: System.Windows.Forms::MenuItem^

The MenuItem to locate in the collection.

Return Value

Type: System::Int32

The zero-based index of the item found in the collection; otherwise, -1.

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 IndexOf method, you retrieve the index of the Exit item in the File menu collection, and then display its value in a message box. This example requires that you have already created a Form named Form1.

public:
   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;

      // Retrieve the index of the Exit menu item.
      String^ indexValue = fileMenu->MenuItems->IndexOf( exitProgram ).ToString();

      // Display the result in a message box.
      MessageBox::Show( "The index of the Exit menu item = "
         + indexValue, "MenuItem Information" );
   }

.NET Framework
Available since 1.1
Return to top
Show: