MenuItemCollection.RemoveAt Method (Int32)

 
System_CAPS_noteNote

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

Removes the MenuItem object at the specified index location from the current MenuItemCollection object.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public void RemoveAt(
	int index
)

Parameters

index
Type: System.Int32

The zero-based index location of the menu item to remove.

Use the RemoveAt method to remove the MenuItem object at the specified index location from the collection. All items that follow that menu item are then moved up to fill in the vacant position. The indexes of the moved items are also updated.

System_CAPS_noteNote

The MenuItemCollection object can contain null values, as well as duplicate MenuItem objects.

As an alternative, you can remove a specific MenuItem object by using the Remove method. You can also remove all menu items from the collection by using the Clear method.

The following code example demonstrates how to use the RemoveAt method to programmatically remove a MenuItem object from a MenuItemCollection object at a specified index location.


<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  void Page_Load(Object sender, EventArgs e)
  {
    if (!IsPostBack)
    {
      // Retrieve the root menu item from the Items
      // collection of the Menu control.
      MenuItem homeMenuItem = NavigationMenu.Items[0];

      // Remove the submenu item at index 0.
      homeMenuItem.ChildItems.RemoveAt(0);
    }
  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>MenuItemCollection RemoveAt Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>MenuItemCollection RemoveAt Example</h3>

      <asp:menu id="NavigationMenu"
        orientation="Vertical"
        target="_blank" 
        runat="server">

        <items>
          <asp:menuitem text="Home"
            tooltip="Home">
            <asp:menuitem text="Music"
              tooltip="Music">
              <asp:menuitem text="Classical"
                tooltip="Classical"/>
              <asp:menuitem text="Rock"
                tooltip="Rock"/>
              <asp:menuitem text="Jazz"
                tooltip="Jazz"/>
            </asp:menuitem>
            <asp:menuitem text="Movies"
              tooltip="Movies">
              <asp:menuitem text="Action"
                tooltip="Action"/>
              <asp:menuitem text="Drama"
                tooltip="Drama"/>
              <asp:menuitem text="Musical"
                tooltip="Musical"/>
            </asp:menuitem>
          </asp:menuitem>
        </items>

      </asp:menu>

    </form>
  </body>
</html>

.NET Framework
Available since 2.0
Return to top
Show: