MenuEventArgs MenuEventArgs MenuEventArgs MenuEventArgs Class

定義

MenuItemClick コントロールの MenuItemDataBound イベントと Menu イベントのデータを提供します。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
継承

イベントのイベントハンドラーに渡されたMenuEventArgsオブジェクトを使用しMenuて、コントロールに表示する前にメニュー項目のプロパティを変更する方法を次のコード例に示します。 MenuItemDataBoundThe 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. メニューHome項目のプロパティは、 ImageUrlそのメニュー項目にのみイメージを表示するように設定されています。The ImageUrl property of the Home menu item is set to display an image in that menu item only. この例を正しく動作させるには、次のサンプルのサイトマップデータを、Web.config という名前のファイルにコピーする必要があります。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>

</siteMapNode>

</siteMap>

注釈

MenuEventArgsクラスは、次の表に示すイベントのイベントハンドラーに渡されるイベントデータを格納するために使用されます。The MenuEventArgs class is used to store the event data passed to an event handler for the events in the following table.

eventEvent 説明Description
MenuItemClick メニュー項目がクリックされたときに発生します。Occurs when a menu item is clicked. このイベントは、通常、コントロールをMenuページ上の別のコントロールと同期するために使用されます。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. このイベントは、通常、メニュー項目をMenuコントロールに表示する前に変更するために使用されます。This event is commonly used to modify a menu item before it is rendered in a Menu control.

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

MenuEventArgs クラスのインスタンスの初期プロパティ値一覧については、MenuEventArgs コンストラクターに関するトピックを参照してください。For a list of initial property values for an instance of the MenuEventArgs class, see the MenuEventArgs constructor.

コンストラクター

MenuEventArgs(MenuItem) MenuEventArgs(MenuItem) MenuEventArgs(MenuItem) MenuEventArgs(MenuItem)

メニュー項目を指定して、MenuEventArgs クラスの新しいインスタンスを初期化します。Initializes a new instance of the MenuEventArgs class using the specified menu item.

MenuEventArgs(MenuItem, Object, CommandEventArgs) MenuEventArgs(MenuItem, Object, CommandEventArgs) MenuEventArgs(MenuItem, Object, CommandEventArgs) MenuEventArgs(MenuItem, Object, CommandEventArgs)

メニュー項目、コマンド ソース、およびイベント引数を指定して、MenuEventArgs クラスの新しいインスタンスを初期化します。Initializes a new instance of the MenuEventArgs class using the specified menu item, command source, and event arguments.

プロパティ

CommandArgument CommandArgument CommandArgument CommandArgument

コマンドの引数を取得します。Gets the argument for the command.

(Inherited from CommandEventArgs)
CommandName CommandName CommandName CommandName

コマンド名を取得します。Gets the name of the command.

(Inherited from CommandEventArgs)
CommandSource CommandSource CommandSource CommandSource

イベントを発生させた Object を取得します。Gets the Object that raised the event.

Item Item Item Item

発生したイベントに関連付けられたメニュー項目を取得します。Gets the menu item associated with the event raised.

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象

こちらもご覧ください