MenuEventArgs Class

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides data for the MenuItemClick and MenuItemDataBound events of a Menu control. This class cannot be inherited.

public ref class MenuEventArgs sealed : System::Web::UI::WebControls::CommandEventArgs

public sealed class MenuEventArgs : System.Web.UI.WebControls.CommandEventArgs

type MenuEventArgs = class
    inherit CommandEventArgs

Public NotInheritable Class MenuEventArgs
Inherits CommandEventArgs

Inheritance: Object

EventArgs

CommandEventArgs
MenuEventArgs

Examples

The following code example demonstrates how to use the MenuEventArgs object passed to the event handler for the MenuItemDataBound event to modify the properties of a menu item before it is displayed in a Menu control. The ImageUrl property of the Home menu item is set to display an image in that menu item only. 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 MenuItemDataBound_NavigationMenu(Object sender, MenuEventArgs e)
  {
    // Display an image for the Home menu item only by
    // setting its ImageUrl property.
    if (e.Item.Text == "Home")
    {
      // Use an @-quoted string to bypass the escape sequence
      // processing.
      e.Item.ImageUrl = @"Images\Home.jpg";
    }
  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>MenuEventArgs Example</title>
</head>
<body>
    <form id="form1" runat="server">
    
      <h3>MenuEventArgs Example</h3>
    
      <asp:menu id="NavigationMenu"
        staticdisplaylevels="2"
        staticsubmenuindent="10" 
        orientation="Vertical"
        datasourceid="menusource" 
        onmenuitemdatabound="MenuItemDataBound_NavigationMenu" 
        runat="server">

      </asp:menu>
      
      <asp:SiteMapDataSource id="MenuSource"
        Runat="server"/>

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


<%@ Page Language="VB" %>

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

  Sub MenuItemDataBound_NavigationMenu(ByVal sender As Object, ByVal e As MenuEventArgs)
  
    ' Display an image for the Home menu item only by
    ' setting its ImageUrl property.
    If e.Item.Text = "Home" Then
    
      e.Item.ImageUrl = "Images\Home.jpg"
      
    End If
      
  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>MenuEventArgs Example</title>
</head>
<body>
    <form id="Form1" runat="server">
    
      <h3>MenuEventArgs Example</h3>
    
      <asp:menu id="NavigationMenu"
        staticdisplaylevels="2"
        staticsubmenuindent="10" 
        orientation="Vertical"
        datasourceid="menusource" 
        onmenuitemdatabound="MenuItemDataBound_NavigationMenu" 
        runat="server">

      </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>

</siteMap>

Remarks

The MenuEventArgs class is used to store the event data passed to an event handler for the events in the following table.

Event	Description
MenuItemClick	Occurs when a menu item is clicked. This event is commonly used to synchronize a Menu control with another control on the page.
MenuItemDataBound	Occurs when a menu item is bound to data. This event is commonly used to modify a menu item before it is rendered in a Menu control.

Depending on the event raised, you can access the menu item clicked by the user or the menu item being bound to data by using the Item property.

For a list of initial property values for an instance of the MenuEventArgs class, see the MenuEventArgs constructor.

Constructors

MenuEventArgs(MenuItem, Object, CommandEventArgs)	Initializes a new instance of the MenuEventArgs class using the specified menu item, command source, and event arguments.
MenuEventArgs(MenuItem)	Initializes a new instance of the MenuEventArgs class using the specified menu item.

Properties

CommandArgument	Gets the argument for the command. (Inherited from CommandEventArgs)
CommandName	Gets the name of the command. (Inherited from CommandEventArgs)
CommandSource	Gets the Object that raised the event.
Item	Gets the menu item associated with the event raised.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Jaa