This documentation is archived and is not being maintained.

Menu.GetMainMenu Method

Gets the MainMenu that contains this menu.

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

public MainMenu GetMainMenu()

Return Value

Type: System.Windows.Forms.MainMenu
The MainMenu that contains this menu.

This method allows you to obtain a reference to the MainMenu this menu is currently located in. This property returns null if the menu is not contained in a MainMenu. This can occur if the menu is contained in a MenuItem or ContextMenu, or if the menu is not contained in any menu. You can use this property to determine whether a menu is currently being used, and also to determine where.

This example declares a MainMenu, mainMenu1, and four menu items, menuItem1, menuItem2, menuItem3, and menuItem4. Only the first three menu items are added to mainMenu1 for display. The program then checks to see if menuItem3 is being used, which is true, and determines the form in which it is used. A label text is used to display the name of the form that hosts the MainMenu. If you change the menu item being tested to menuItem4, the condition evaluates to false because menuItem4 has never been used. This example requires that you have created a Form named MyForm that includes a Label named label1.

		private void InitializeMyMainMenu()
			// Create the MainMenu and the menu items to add.
			MainMenu mainMenu1 = new MainMenu();

			MenuItem menuItem1 = new MenuItem();
			MenuItem menuItem2 = new MenuItem();
			MenuItem menuItem3 = new MenuItem();
			MenuItem menuItem4 = new MenuItem();

			// Set the caption for the menu items.
			menuItem1.Text = "File";
			menuItem2.Text = "Edit";
			menuItem3.Text = "View";

			// Add 3 menu items to the MainMenu for displaying.

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

			// Determine whether menuItem3 is currently being used. 
			if(menuItem3.GetMainMenu() != null)
				// Display the name of the form in which it is located.
				label1.Text= menuItem3.GetMainMenu().GetForm().ToString();

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0