Menu.MergeMenu Method (Menu)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Merges the MenuItem objects of one menu with the current menu.

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

public virtual void MergeMenu(
	Menu menuSrc


Type: System.Windows.Forms.Menu

The Menu whose menu items are merged with the menu items of the current menu.

Exception Condition

It was attempted to merge the menu with itself.

This method merges MenuItem objects from one menu with the current menu. MenuItem objects are merged according to the values of the MenuItem.MergeType and MenuItem.MergeOrder properties.

Menu merging is typically done to merge the menus of a Multiple Document Interface (MDI) parent form with those of its active MDI child form. This is performed automatically by the .NET Framework common language runtime. For example, if an MDI parent form contains a set of menus for handling files and your MDI child form also has file-related menu items, the menu sets will automatically merge into a single file menu set when the child form is displayed in the MDI parent form.

You can use the MergeMenu method if you are merging two menu structures that are not part of an MDI application. This implementation can be called by the MainMenu or ContextMenu classes to merge two or more objects that derive from Menu.

To merge two MenuItem objects use the MenuItem.MergeMenu method.

This example creates two menus, mainMenu1 and mainMenu2. The first menu contains one MenuItem, File, and the second contains one MenuItem, Edit. Using the MergeMenu method, mainMenu2 is merged with mainMenu1. When displayed, mainMenu1 will contain the two menu items, File and Edit. This example requires that you have created a Form named Form1.

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

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

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

	// Add a menu item to each menu for displaying.

	// Merge mainMenu2 with mainMenu1

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

.NET Framework
Available since 1.1
Return to top