MenuItem.Index Property

 

Gets or sets a value indicating the position of the menu item in its parent menu.

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

[BrowsableAttribute(false)]
public int Index { get; set; }

Property Value

Type: System.Int32

The zero-based index representing the position of the menu item in its parent menu.

Exception Condition
ArgumentOutOfRangeException

The assigned value is less than zero or greater than the item count.

This property provides the indexed position of a menu item in the menu item collection of its parent menu. You can use this property to reposition a menu item to a different location within its menu. You can also use this property when creating a MenuItem to specify its position in a menu structure at the time of creation.

The following code example switches the position of two menu items in a menu. The following code example requires that two MenuItem objects are created named menuItem1 and menuItem2. The menuItem1 menu item moves down one position in the menu, while menuItem2 moves up one position.

public void SwitchMyMenuItems()
{
   // Move menuItem1 down one position in the menu order.
   menuItem1.Index = menuItem1.Index + 1;
   // Move menuItem2 up one position in the menu order.
   menuItem2.Index = menuItem2.Index - 1;
}

.NET Framework
Available since 1.1
Return to top
Show: