ImageButton.CommandArgument プロパティ

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

ImageButton.CommandArgument プロパティ

CommandName プロパティに関する追加情報を提供するオプション引数を取得または設定します。

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

Visual Basic (宣言)

<ThemeableAttribute(False)> _
<BindableAttribute(True)> _
Public Property CommandArgument As
 String

Visual Basic (使用法)

Dim instance As ImageButton
Dim value As String

value = instance.CommandArgument

instance.CommandArgument = value

C#

[ThemeableAttribute(false)] 
[BindableAttribute(true)] 
public string CommandArgument { get;
 set; }

C++

[ThemeableAttribute(false)] 
[BindableAttribute(true)] 
public:
virtual property String^ CommandArgument {
    String^ get () sealed;
    void set (String^ value) sealed;
}

J#

/** @property */
public final String get_CommandArgument ()

/** @property */
public final void set_CommandArgument (String
 value)

JScript

public final function get
 CommandArgument () : String

public final function set
 CommandArgument (value : String)

プロパティ値
CommandName プロパティを補足するオプション引数。

解説

場合によっては、複数の ImageButton コントロールが関連付けられ、CommandName プロパティの値として、Sort などの同じ値を共有することがあります。このプロパティを使用して、CommandName プロパティに、Ascending などの実行するコマンドに関する追加情報を補足します。CommandName プロパティおよび CommandArgument プロパティの各値は、通常、OnCommand イベント ハンドラで使用され、ImageButton コントロールがクリックされたときに実行するアクションを決定します。

このプロパティを、テーマまたはスタイル シート テーマを使用して設定することはできません。詳細については、ThemeableAttribute、ASP.NET のテーマとスキンの概要 の各トピックを参照してください。

使用例

CommandArgument プロパティを使用して、コマンド引数と ImageButton コントロールを関連付ける方法の例を次に示します。

メモ
次のコード サンプルはシングルファイル コード モデルを使用しており、分離コード ファイルに直接コピーされた場合は正常に動作しない可能性があります。このコード サンプルは、拡張子が .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>

C#

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

プラットフォーム

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、1.1、1.0

参照

関連項目
ImageButton クラス
ImageButton メンバ
System.Web.UI.WebControls 名前空間
CommandName
OnCommand
Button クラス
Image クラス
その他の技術情報
ImageButton Web サーバー コントロールの宣言構文
Button Web サーバー コントロールの概要