MenuEventArgs クラス

定義

MenuItemClick コントロールの MenuItemDataBound イベントと Menu イベントのデータを提供します。 このクラスは継承できません。

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
継承

次のコード例では、イベントハンドラーMenuItemDataBoundに渡されたオブジェクトを使用MenuEventArgsして、メニュー項目のプロパティを変更してからコントロールに表示する方法をMenu示します。 メニュー項目の Home プロパティはImageUrl、そのメニュー項目にのみ画像を表示するように設定されています。 この例を正しく機能させるには、以下のサンプル サイト マップ データを 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>

前の例のサイト マップ データのサンプルを次に示します。

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

注釈

クラスは MenuEventArgs 、次の表のイベントのイベント ハンドラーに渡されるイベント データを格納するために使用されます。

Event 説明
MenuItemClick メニュー項目がクリックされたときに発生します。 このイベントは、通常、ページ上の別の Menu コントロールとコントロールを同期するために使用されます。
MenuItemDataBound メニュー項目がデータにバインドされるときに発生します。 このイベントは、通常、コントロールにレンダリングされる前にメニュー項目を Menu 変更するために使用されます。

発生したイベントに応じて、 プロパティを使用して、ユーザーがクリックしたメニュー項目またはデータにバインドされているメニュー項目に Item アクセスできます。

MenuEventArgs クラスのインスタンスの初期プロパティ値一覧については、MenuEventArgs コンストラクターに関するトピックを参照してください。

コンストラクター

MenuEventArgs(MenuItem)

メニュー項目を指定して、MenuEventArgs クラスの新しいインスタンスを初期化します。

MenuEventArgs(MenuItem, Object, CommandEventArgs)

メニュー項目、コマンド ソース、およびイベント引数を指定して、MenuEventArgs クラスの新しいインスタンスを初期化します。

プロパティ

CommandArgument

コマンドの引数を取得します。

(継承元 CommandEventArgs)
CommandName

コマンドの名前を取得します。

(継承元 CommandEventArgs)
CommandSource

イベントを発生させた Object を取得します。

Item

発生したイベントに関連付けられたメニュー項目を取得します。

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

適用対象

こちらもご覧ください