Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

MenuItem.MergeOrder Property

Gets or sets a value indicating the relative position of the menu item when it is merged with another.

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

Public Property MergeOrder As Integer
Dim instance As MenuItem 
Dim value As Integer 

value = instance.MergeOrder

instance.MergeOrder = value

Property Value

Type: System.Int32
A zero-based index representing the merge order position for this menu item. The default is 0.

The merge order of a menu item specifies the relative position that this menu item will take if the menu structure that the MenuItem is contained in is merged with another.

The following code example demonstrates using the MergeOrder property to control the way a merged menu is displayed. This is a complete example, ready to run once you add it to your project.

' The following code example demonstrates using the MenuItem  
' Merge-Order property to control the way a merged menu is displayed. 

Imports System.Windows.Forms

Public Class Form1
    Inherits System.Windows.Forms.Form

    'Declare a MainMenu object and its items. 
    Friend WithEvents mainMenu1 As System.Windows.Forms.MainMenu
    Friend WithEvents fileItem As System.Windows.Forms.MenuItem
    Friend WithEvents newItem As System.Windows.Forms.MenuItem
    Friend WithEvents openItem As System.Windows.Forms.MenuItem
    Friend WithEvents saveItem As System.Windows.Forms.MenuItem
    Friend WithEvents optionsMenu As System.Windows.Forms.MenuItem
    Friend WithEvents viewItem As System.Windows.Forms.MenuItem
    Friend WithEvents toolsItem As System.Windows.Forms.MenuItem

    ' Declare a ContextMenu object and its items. 
    Friend WithEvents contextMenu1 As System.Windows.Forms.ContextMenu
    Friend WithEvents cutItem As System.Windows.Forms.MenuItem
    Friend WithEvents copyItem As System.Windows.Forms.MenuItem
    Friend WithEvents pasteItem As System.Windows.Forms.MenuItem

    Public Sub New()
        Me.mainMenu1 = New System.Windows.Forms.MainMenu
        Me.fileItem = New System.Windows.Forms.MenuItem
        Me.newItem = New System.Windows.Forms.MenuItem
        Me.openItem = New System.Windows.Forms.MenuItem
        Me.saveItem = New System.Windows.Forms.MenuItem

        Me.viewItem = New System.Windows.Forms.MenuItem
        Me.toolsItem = New System.Windows.Forms.MenuItem

        Me.optionsMenu = New System.Windows.Forms.MenuItem
        Me.toolsItem = New System.Windows.Forms.MenuItem
        Me.viewItem = New System.Windows.Forms.MenuItem

        Me.contextMenu1 = New System.Windows.Forms.ContextMenu
        Me.cutItem = New System.Windows.Forms.MenuItem
        Me.copyItem = New System.Windows.Forms.MenuItem
        Me.pasteItem = New System.Windows.Forms.MenuItem

        'Add file menu item and options menu item to the MainMenu. 
        Me.mainMenu1.MenuItems.AddRange(New System.Windows.Forms.MenuItem() _
             {Me.fileItem, Me.optionsMenu})

        ' Initialize the file menu and its contents. 
        Me.fileItem.Index = 0
        Me.fileItem.Text = "File" 
        Me.newItem.Index = 0
        Me.newItem.Text = "New" 
        Me.openItem.Index = 1
        Me.openItem.Text = "Open" 
        Me.saveItem.Index = 2
        Me.saveItem.Text = "Save" 

        ' Set the merge order of fileItem to 2 so it has a lower priority  
        ' on the merged menu. 
        Me.fileItem.MergeOrder = 2

        'Add the new items to the fileItem menu item collection. 
        Me.fileItem.MenuItems.AddRange(New MenuItem() _
           {Me.newItem, Me.openItem, Me.saveItem})

        ' Initalize the optionsMenu item and its contents. 
        Me.optionsMenu.Index = 1
        Me.optionsMenu.Text = "Options" 

        Me.viewItem.Index = 0
        Me.viewItem.Text = "View" 
        Me.toolsItem.Index = 1
        Me.toolsItem.Text = "Tools" 

        ' Set mergeOrder property to 1, so it has a higher priority than 
        ' the fileItem on the merged menu. 
        Me.optionsMenu.MergeOrder = 1

        'Add view and tool items to the optionsItem menu item. 
        Me.optionsMenu.MenuItems.AddRange _
            (New MenuItem() {Me.viewItem, Me.toolsItem})

        ' Initialize the menu items for the shortcut menu. 
        Me.cutItem.Index = 0
        Me.cutItem.Text = "Cut" 
        Me.cutItem.MergeOrder = 0
        Me.copyItem.Index = 1
        Me.copyItem.Text = "Copy" 
        Me.copyItem.MergeOrder = 0
        Me.pasteItem.Index = 2
        Me.pasteItem.Text = "Paste" 
        Me.pasteItem.MergeOrder = 0

        ' Add menu items to the shortcut menu.
        contextMenu1.MenuItems.AddRange _
            (New MenuItem() {cutItem, copyItem, pasteItem})

        ' Add the mainMenu1 items to the shortcut menu as well, by 
        ' calling the MergeMenu method.

        'Initialize the form. 
        Me.ClientSize = New System.Drawing.Size(292, 266)
        Me.Name = "Form1" 
        Me.Text = "Right click on form for merged menu." 

        ' Add mainMenu1 to the form. 
        Me.Menu = mainMenu1

    End Sub 

    Private Sub Form1_MouseDown(ByVal sender As Object, _
        ByVal e As MouseEventArgs) Handles MyBase.MouseDown

        ' Check for a right mouse click. 
        If (e.Button = MouseButtons.Right) Then 

            ' Display a merged menu containing items from mainMenu1  
            ' and contextMenu1.
            contextMenu1.Show(Me, New System.Drawing.Point(30, 30))
        End If 
    End Sub

    <System.STAThreadAttribute()> Public Shared Sub Main()
        Application.Run(New Form1)
    End Sub 

End Class
	Merge-Order property to control the way a merged menu is displayed.

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

Community Additions

© 2015 Microsoft