This documentation is archived and is not being maintained.

MenuMerge Enumeration

Specifies the behavior of a MenuItem when it is merged with items in another menu.

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

public enum MenuMerge

Member nameDescription
AddThe MenuItem is added to the collection of existing MenuItem objects in a merged menu.
ReplaceThe MenuItem replaces an existing MenuItem at the same position in a merged menu.
MergeItemsAll submenu items of this MenuItem are merged with those of existing MenuItem objects at the same position in a merged menu.
RemoveThe MenuItem is not included in a merged menu.

Use the members of this enumeration to set the value of the MergeType property of the MenuItem.

The following example uses this version of the MergeMenu method to create a copy of a MenuItem and merge it with another. The merged MenuItem is then added to a ContextMenu control. This example assumes that there are two menu items called menuItem1 and menuItem2 that contain submenu items within them and a ContextMenu named contextMenu1 to display the menu items. menuItem1 and menuItem2 have different menu items contained within them. After the call to MergeMenu is made, a consolidated menu is created.

 private void MergeMyMenus()
    // Set the merge type to merge the items from both top menu items.
    menuItem1.MergeType = MenuMerge.MergeItems;
    menuItem2.MergeType = MenuMerge.MergeItems;
    // Create a copy of my menu item.
    MenuItem tempMenuItem = new MenuItem();
    // Create a copy of menuItem1 before doing the merge.
    tempMenuItem = menuItem1.CloneMenu();
    // Merge menuItem1's copy with a clone of menuItem2

    // Add the merged menu to the ContextMenu control.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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