MenuEventArgs

.NET Framework クラス ライブラリ リファレンス

MenuEventArgs クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 MenuEventArgs
    Inherits CommandEventArgs

Visual Basic (使用法)

Dim instance As MenuEventArgs

C#

public sealed class MenuEventArgs : CommandEventArgs

C++

public ref class MenuEventArgs sealed : public
 CommandEventArgs

J#

public final class MenuEventArgs extends CommandEventArgs

JScript

public final class MenuEventArgs extends
 CommandEventArgs

解説

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

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

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

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

使用例

MenuItemDataBound イベントのイベント ハンドラに渡される MenuEventArgs オブジェクトを使用して、メニュー項目を Menu コントロールに表示する前に、メニュー項目のプロパティを変更する方法のコード例を次に示します。Home メニュー項目の ImageUrl プロパティは、そのメニュー項目だけにイメージを表示する場合に設定されます。この例を正常に動作させるには、以下のサンプル サイト マップ データを、Web.sitemap という名前のファイルにコピーする必要があります。

Visual Basic

<%@ Page Language="VB" %>

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

C#

<%@ Page Language="C#" %>

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

.NET Framework のセキュリティ

• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : LinkDemand; アクセス許可値 : Minimal。
• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : InheritanceDemand; アクセス許可値 : Minimal。

継承階層

System.Object
   System.EventArgs
     System.Web.UI.WebControls.CommandEventArgs
      System.Web.UI.WebControls.MenuEventArgs

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
MenuEventArgs メンバ
System.Web.UI.WebControls 名前空間
Menu クラス
MenuItem
MenuEventHandler
Menu.MenuItemClick イベント
OnMenuItemClick
Menu.MenuItemDataBound イベント
OnMenuItemDataBound

MenuEventArgs コンストラクタ (MenuItem, Object, CommandEventArgs)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    item As MenuItem, _
    commandSource As Object, _
    originalArgs As CommandEventArgs _
)

Visual Basic (使用法)

Dim item As MenuItem
Dim commandSource As Object
Dim originalArgs As CommandEventArgs

Dim instance As New MenuEventArgs(item,
 commandSource, originalArgs)

C#

public MenuEventArgs (
    MenuItem item,
    Object commandSource,
    CommandEventArgs originalArgs
)

C++

public:
MenuEventArgs (
    MenuItem^ item, 
    Object^ commandSource, 
    CommandEventArgs^ originalArgs
)

J#

public MenuEventArgs (
    MenuItem item, 
    Object commandSource, 
    CommandEventArgs originalArgs
)

JScript

public function MenuEventArgs (
    item : MenuItem, 
    commandSource : Object, 
    originalArgs : CommandEventArgs
)

パラメータ

item

MenuItemClick イベントでは、このパラメータはユーザーがクリックしたメニュー項目を表します。MenuItemDataBound イベントでは、このパラメータはデータにバインドされるメニュー項目を表します。

commandSource

イベントの発生元の Object。

originalArgs

メニュー項目のコマンド名とコマンド引数の値を格納する CommandEventArgs。

解説

このコンストラクタを使用して、指定したメニュー項目、コマンド ソース、およびイベント引数から MenuEventArgs クラスの新しいインスタンスを作成します。MenuEventArgs クラスのインスタンスの初期プロパティ値を次の表に示します。

プロパティ	初期値
CommandArgument	originalArgs.CommandArgument パラメータの値。
CommandName	originalArgs.CommandName パラメータの値。
CommandSource	commandSource パラメータで指定された Object。
Item	item パラメータで指定された MenuItem オブジェクト。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
MenuEventArgs クラス
MenuEventArgs メンバ
System.Web.UI.WebControls 名前空間
CommandEventArgs クラス
MenuItem
CommandEventArgs.CommandArgument プロパティ
CommandEventArgs.CommandName プロパティ
CommandSource
Item
Menu.MenuItemClick イベント
Menu.MenuItemDataBound イベント

MenuEventArgs コンストラクタ (MenuItem)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    item As MenuItem _
)

Visual Basic (使用法)

Dim item As MenuItem

Dim instance As New MenuEventArgs(item)

C#

public MenuEventArgs (
    MenuItem item
)

C++

public:
MenuEventArgs (
    MenuItem^ item
)

J#

public MenuEventArgs (
    MenuItem item
)

JScript

public function MenuEventArgs (
    item : MenuItem
)

パラメータ

item

MenuItemClick イベントでは、このパラメータはユーザーがクリックしたメニュー項目を表します。MenuItemDataBound イベントでは、このパラメータはデータにバインドされるメニュー項目を表します。

解説

このコンストラクタを使用して、指定したメニュー項目から MenuEventArgs クラスの新しいインスタンスを作成します。MenuEventArgs クラスのインスタンスの初期プロパティ値を次の表に示します。

プロパティ	初期値
CommandArgument	null 参照 (Visual Basic では Nothing)
CommandName	Empty
CommandSource	null 参照 (Visual Basic では Nothing)
Item	item パラメータで指定された MenuItem オブジェクト。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
MenuEventArgs クラス
MenuEventArgs メンバ
System.Web.UI.WebControls 名前空間
MenuItem
CommandEventArgs.CommandArgument プロパティ
CommandEventArgs.CommandName プロパティ
CommandSource
Item
Menu.MenuItemClick イベント
Menu.MenuItemDataBound イベント

MenuEventArgs コンストラクタ

MenuEventArgs クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
MenuEventArgs (MenuItem)	メニュー項目を指定して、MenuEventArgs クラスの新しいインスタンスを初期化します。
MenuEventArgs (MenuItem, Object, CommandEventArgs)	メニュー項目、コマンド ソース、およびイベント引数を指定して、MenuEventArgs クラスの新しいインスタンスを初期化します。

参照

関連項目

MenuEventArgs クラス
MenuEventArgs メンバ
System.Web.UI.WebControls 名前空間
MenuItem
CommandEventArgs.CommandArgument プロパティ
CommandEventArgs.CommandName プロパティ
CommandSource
Item
Menu.MenuItemClick イベント
Menu.MenuItemDataBound イベント

MenuEventArgs プロパティ

パブリック プロパティ

	名前	説明
	CommandArgument	コマンドの引数を取得します。 ( CommandEventArgs から継承されます。)
	CommandName	コマンド名を取得します。 ( CommandEventArgs から継承されます。)
	CommandSource	イベントを発生させる Object を取得します。
	Item	発生したイベントに関連付けられたメニュー項目を取得します。

参照

関連項目

MenuEventArgs クラス
System.Web.UI.WebControls 名前空間
Menu クラス
MenuItem
MenuEventHandler
Menu.MenuItemClick イベント
OnMenuItemClick
Menu.MenuItemDataBound イベント
OnMenuItemDataBound

MenuEventArgs メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

MenuEventArgs クラス
System.Web.UI.WebControls 名前空間
Menu クラス
MenuItem
MenuEventHandler
Menu.MenuItemClick イベント
OnMenuItemClick
Menu.MenuItemDataBound イベント
OnMenuItemDataBound

MenuEventArgs メンバ

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

MenuEventArgs データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	MenuEventArgs	オーバーロードされます。 MenuEventArgs クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	CommandArgument	コマンドの引数を取得します。(CommandEventArgs から継承されます。)
	CommandName	コマンド名を取得します。(CommandEventArgs から継承されます。)
	CommandSource	イベントを発生させる Object を取得します。
	Item	発生したイベントに関連付けられたメニュー項目を取得します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

MenuEventArgs クラス
System.Web.UI.WebControls 名前空間
Menu クラス
MenuItem
MenuEventHandler
Menu.MenuItemClick イベント
OnMenuItemClick
Menu.MenuItemDataBound イベント
OnMenuItemDataBound