MenuItem.Selected Property

 
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.

Gets or sets a value indicating whether the current menu item is selected in a Menu control.

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

[BrowsableAttribute(true)]
public bool Selected { get; set; }

Property Value

Type: System.Boolean

true to indicate that the current menu item is selected in a Menu control; otherwise, false. The default is false.

Use the Selected property to specify or determine whether the current menu item is selected.

System_CAPS_noteNote

Although the property can be used to determine whether a menu item is selected, it is more common to use the SelectedItem property.

Only one menu item can be selected at a time in the Menu control.

The following example demonstrates how to use the Selected property to select a specific menu item in a Menu control when the page is first loaded. For this example to work correctly, you must copy the sample site map data below to a file named Web.sitemap.


<%@ 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 NavigationMenu_MenuItemDataBound(Object sender, MenuEventArgs e)
  {
    // Get the menu item being bound to data.
    MenuItem item = e.Item;

    // Use the Selected property to select the Home 
    // menu item when the page is first loaded.
    if (item.Text == "Home")
    {
      item.Selected = true;
    }
  }

</script>

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

      <h3>MenuItem Selected Example</h3>

      <asp:menu id="NavigationMenu"
        staticdisplaylevels="2"
        staticsubmenuindent="10" 
        orientation="Vertical"
        target="_blank"
        datasourceid="MenuSource"
        onmenuitemdatabound="NavigationMenu_MenuItemDataBound" 
        runat="server">

        <staticselectedstyle backcolor="Yellow"/>

      </asp:menu>

      <asp:sitemapdatasource id="MenuSource"
        runat="server"/>        

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

The following is sample site map data for the previous example.

<siteMap>

<siteMapNode url="~\Home.aspx"

title="Home"

description="Home">

<siteMapNode url="~\Music.aspx"

title="Music"

description="Music">

<siteMapNode url="~\Classical.aspx"

title="Classical"

description="Classical"/>

<siteMapNode url="~\Rock.aspx"

title="Rock"

description="Rock"/>

<siteMapNode url="~\Jazz.aspx"

title="Jazz"

description="Jazz"/>

</siteMapNode>

<siteMapNode url="~\Movies.aspx"

title="Movies"

description="Movies">

<siteMapNode url="~\Action.aspx"

title="Action"

description="Action"/>

<siteMapNode url="~\Drama.aspx"

title="Drama"

description="Drama"/>

<siteMapNode url="~\Musical.aspx"

title="Musical"

description="Musical"/>

</siteMapNode>

</siteMapNode>

</siteMap>

.NET Framework
Available since 2.0
Return to top
Show: