Menu.MenuItemCollection.Contains Method (MenuItem)


Determines if the specified MenuItem is a member of the collection.

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

public bool Contains(
	MenuItem value


Type: System.Windows.Forms.MenuItem

The MenuItem to locate in the collection.

Return Value

Type: System.Boolean

true if the MenuItem is a member of the collection; otherwise, false.

This method enables you to determine whether a MenuItem is member of the collection before attempting to perform operations on the MenuItem. You can use this method to confirm that a MenuItem has been added to or is still a member of the collection.

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. By using the Contains method, you check to see if the File menu collection contains the item Open. If the item exists, you display the result in a text box. This program requires that you have already created a Form named Form1.

public void InitializeMenu()
	// 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.

	// Add three submenus to the File menu.

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

	// Check that the File menu contains the Open menu item.
	if (fileMenu.MenuItems.Contains(openFile))
		MessageBox.Show("The File menu contains 'Open' ", fileMenu.Text);

.NET Framework
Available since 1.1
Return to top