MenuItemCollection.Remove Method (MenuItem)

 

Removes the specified MenuItem object from the MenuItemCollection object.

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

public void Remove(
	MenuItem value
)

Parameters

value
Type: System.Web.UI.WebControls.MenuItem

The MenuItem object to remove.

Exception Condition
ArgumentNullException

value is null.

Use the Remove method to remove the specified menu item 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 menu item from a specific index in the collection by using the RemoveAt 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 Remove method to programmatically remove a MenuItem object from a MenuItemCollection object.


<%@ 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];

      // Retrieve the Movie submenu item from the ChildItems
      // collection of the root menu item.
      MenuItem movieSubMenuItem = NavigationMenu.FindItem(@"Home\Movies");

      // Remove the Movie submenu item.
      if (movieSubMenuItem != null)
      {
        homeMenuItem.ChildItems.Remove(movieSubMenuItem);
      }
    }
  }

</script>

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

      <h3>MenuItemCollection Remove 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: