ImageButton.OnCommand メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

ImageButton.OnCommand メソッド

Command イベントを発生させて、Command イベントを直接処理できるようにします。

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

Visual Basic (宣言)

Protected Overridable Sub
 OnCommand ( _
    e As CommandEventArgs _
)

Visual Basic (使用法)

Dim e As CommandEventArgs

Me.OnCommand(e)

protected virtual void OnCommand (
    CommandEventArgs e
)

C++

protected:
virtual void OnCommand (
    CommandEventArgs^ e
)

protected void OnCommand (
    CommandEventArgs e
)

JScript

protected function OnCommand (
    e : CommandEventArgs
)

パラメータ

e: イベントデータを格納している CommandEventArgs。

解説

Command イベントは、ImageButton コントロールがクリックされたときに発生します。OnCommand イベントハンドラを使用して、ImageButton コントロールがコマンドボタンのような動作をするように設定できます。CommandName プロパティを使用して、コマンド名をコントロールに関連付けることができます。これにより、複数の ImageButton コントロールを Web ページ上に配置できます。さらに、このプロパティの値を OnCommand イベントハンドラでプログラムにより識別して、各 ImageButton コントロールがクリックされたときに実行する適切なアクションを決定できます。CommandArgument プロパティを使用して、昇順の指定など、コマンドについての追加情報を渡すこともできます。

メモ
BubbleEvent の形式でコントロールの階層構造を通じて Command イベントが発生します。

イベントが発生すると、デリゲートを使用してイベントハンドラが呼び出されます。詳細については、「方法 : Web フォームアプリケーションでイベントを利用する」を参照してください。

OnCommand メソッドを使用すると、デリゲートを結び付けずに、派生クラスでイベントを処理することもできます。派生クラスでイベントを処理する場合は、この手法をお勧めします。

継承時の注意 派生クラスで OnCommand をオーバーライドする場合は、登録されているデリゲートがイベントを受け取ることができるように、基本クラスの OnCommand メソッドを呼び出してください。

使用例

Command イベントのハンドラを指定およびコード化して、どの ImageButton コントロールがクリックされたかを確認する方法の例を次に示します。

メモ
次のコードサンプルはシングルファイルコードモデルを使用しており、分離コードファイルに直接コピーされた場合は正常に動作しない可能性があります。このコードサンプルは、拡張子が .aspx の空のテキストファイルにコピーする必要があります。Web フォームのコードモデルの詳細については、「ASP.NET Web ページのコードモデル」を参照してください。

メモ

次のコードサンプルはシングルファイルコードモデルを使用しており、分離コードファイルに直接コピーされた場合は正常に動作しない可能性があります。このコードサンプルは、拡張子が .aspx の空のテキストファイルにコピーする必要があります。Web フォームのコードモデルの詳細については、「ASP.NET Web ページのコードモデル」を参照してください。

Visual Basic

<%@ Page Language="VB" AutoEventWireup="True"
 %>
<html>
<head>

   <script language="VB" runat="server">

      Sub ImageButton_Command(sender As Object,
 e As CommandEventArgs) 
         If (e.CommandName = "Sort")
 And (e.CommandArgument = "Ascending")
 Then
            Label1.Text = "You clicked the Sort Ascending Button"
         Else
            Label1.Text = "You clicked the Sort Descending Button"
         End If
      End Sub

   </script>

</head>

<body>

   <form runat="server">

      <h3>ImageButton CommandName Sample</h3>

      Click an image.<br><br>

      <asp:ImageButton id="imagebutton1" runat="server"
           AlternateText="Sort Ascending"
           ImageUrl="images/pict.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"
           CommandArgument="Ascending"/>

      <asp:ImageButton id="imagebutton2" runat="server"
           AlternateText="Sort Descending"
           ImageUrl="images/pict2.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"
           CommandArgument="Descending"/>

      <br><br>
    
      <asp:label id="Label1" runat="server"/>

   </form>

</body>
</html>

<%@ Page Language="C#" AutoEventWireup="True" %>
<html>
<head>

   <script language="C#" runat="server">

      void ImageButton_Command(object sender, CommandEventArgs
 e) 
      {
         if (e.CommandName == "Sort" && e.CommandArgument
 == "Ascending")
            Label1.Text = "You clicked the Sort Ascending Button";
         else
            Label1.Text = "You clicked the Sort Descending Button";
      }

   </script>

</head>

<body>

   <form runat="server">

      <h3>ImageButton CommandName Sample</h3>

      Click an image.<br><br>

      <asp:ImageButton id="imagebutton1" runat="server"
           AlternateText="Sort Ascending"
           ImageUrl="images/pict.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"
           CommandArgument="Ascending"/>

      <asp:ImageButton id="imagebutton2" runat="server"
           AlternateText="Sort Descending"
           ImageUrl="image/pict2.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"
           CommandArgument="Descending"/>

      <br><br>
    
      <asp:label id="Label1" runat="server"/>

   </form>

</body>
</html>

JScript

<%@ Page Language="JScript" AutoEventWireup="True" %>
<html>
<head>

   <script language="JSCRIPT" runat="server">

      function ImageButton_Command(sender : Object, e : CommandEventArgs){
         if(e.CommandName == "Sort" && e.CommandArgument
 == "Ascending")
            Label1.Text = "You clicked the Sort Ascending Button"
         else
            Label1.Text = "You clicked the Sort Descending Button"
      }

   </script>

</head>

<body>

   <form runat="server">

      <h3>ImageButton CommandName Sample</h3>

      Click an image.<br><br>

      <asp:ImageButton id="imagebutton1" runat="server"
           AlternateText="Sort Ascending"
           ImageUrl="images/pict.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"
           CommandArgument="Ascending"/>

      <asp:ImageButton id="imagebutton2" runat="server"
           AlternateText="Sort Descending"
           ImageUrl="images/pict2.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"
           CommandArgument="Descending"/>

      <br><br>
    
      <asp:label id="Label1" runat="server"/>

   </form>

</body>
</html>