Button.CommandArgument プロパティとは何？わかりやすく解説 Weblio辞書

すべての辞書から再検索する

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

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

Button.CommandArgument プロパティ

関連付けられている CommandName と共に Command イベントに渡された省略可能なパラメータを取得または設定します。

名前空間: 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 Button
Dim value As String

value = instance.CommandArgument

instance.CommandArgument = value

[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;
}

/** @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 と共に Command イベントに渡された省略可能なパラメータ。既定値は String.Empty です。

解説

CommandArgument プロパティを使用して、CommandName プロパティを補足するパラメータを指定します。

メモ
CommandArgument プロパティは単独で設定することもできますが、通常は CommandName プロパティと一緒に設定して使用します。

CommandArgument プロパティは CommandName プロパティを補足し、実行するコマンドの追加情報を提供します。たとえば、CommandName プロパティを Sort に設定し、CommandArgument プロパティを Ascending に設定すると、昇順での並べ替えを実行するコマンドが指定されます。

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

使用例

CommandArgument プロパティを使用して、リストを昇順で並べ替える Button コントロールを作成する方法を次のコード例に示します。

Visual Basic

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

<html>
<head>

   <script runat="server">

      Sub CommandBtn_Click(sender As Object,
 e As CommandEventArgs) 

         Select e.CommandName

            Case "Sort"

               ' Call the method to sort the list.
               Sort_List(CType(e.CommandArgument, String))

            Case "Submit"

               ' Display a message for the Submit button being clicked.
               Message.Text = "You clicked the Submit button"

               ' Test whether the command argument is an empty string
 ("").
               If CType(e.CommandArgument , String)
 = "" Then
              
                  ' End the message.
                  Message.Text &= "."
               
               Else
               
                  ' Display an error message for the command argument.
 
                  Message.Text &= ", however the command argument
 is not recogized."
               
               End If                

            Case Else

               ' The command name is not recognized. Display an error
 message.
               Message.Text = "Command name not recogized."

         End Select

      End Sub

      Sub Sort_List(commandArgument As String)

         Select commandArgument

            Case "Ascending"
 
               ' Insert code to sort the list in ascending order here.
               Message.Text = "You clicked the Sort Ascending
 button."

            Case "Descending"
              
               ' Insert code to sort the list in descending order here.
               Message.Text = "You clicked the Sort Descending
 button."

            Case Else
        
               ' The command argument is not recognized. Display an
 error message.
               Message.Text = "Command argument not recogized."

         End Select

      End Sub

   </script>

</head>
 
<body>

   <form runat="server">

      <h3>Button CommandName Example</h3>

      Click on one of the command buttons.

      <br><br>
 
      <asp:Button id="Button1"
           Text="Sort Ascending"
           CommandName="Sort"
           CommandArgument="Ascending"
           OnCommand="CommandBtn_Click" 
           runat="server"/>

      &nbsp;

      <asp:Button id="Button2"
           Text="Sort Descending"
           CommandName="Sort"
           CommandArgument="Descending"
           OnCommand="CommandBtn_Click" 
           runat="server"/>

      <br><br>

      <asp:Button id="Button3"
           Text="Submit"
           CommandName="Submit"
           OnCommand="CommandBtn_Click" 
           runat="server"/>

      &nbsp;

      <asp:Button id="Button4"
           Text="Unknown Command Name"
           CommandName="UnknownName"
           CommandArgument="UnknownArgument"
           OnCommand="CommandBtn_Click" 
           runat="server"/>

      &nbsp;

      <asp:Button id="Button5"
           Text="Submit Unknown Command Argument"
           CommandName="Submit"
           CommandArgument="UnknownArgument"
           OnCommand="CommandBtn_Click" 
           runat="server"/>
       
      <br><br>

      <asp:Label id="Message" runat="server"/>
 
   </form>
 
</body>
</html>

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

<html>
<head>

   <script runat="server">

      void CommandBtn_Click(Object sender, CommandEventArgs e)
 
      {

         switch(e.CommandName)
         {

            case "Sort":

               // Call the method to sort the list.
               Sort_List((String)e.CommandArgument);
               break;

            case "Submit":

               // Display a message for the Submit button being clicked.
               Message.Text = "You clicked the Submit button";

               // Test whether the command argument is an empty string
 ("").
               if((String)e.CommandArgument == "")
               {
                  // End the message.
                  Message.Text += ".";
               }
               else
               {
                  // Display an error message for the command argument.
 
                  Message.Text += ", however the command argument is not recogized.";
               }                
               break;

            default:

               // The command name is not recognized. Display an error
 message.
               Message.Text = "Command name not recogized.";
               break; 

         }

      }

      void Sort_List(string commandArgument)
      {

         switch(commandArgument)
         {

            case "Ascending":
 
               // Insert code to sort the list in ascending order here.
               Message.Text = "You clicked the Sort Ascending button.";
               break;

            case "Descending":
              
               // Insert code to sort the list in descending order here.
               Message.Text = "You clicked the Sort Descending button.";
               break;

            default:
        
               // The command argument is not recognized. Display an
 error message.
               Message.Text = "Command argument not recogized.";
               break;

         }

      }

   </script>

</head>
 
<body>

   <form runat="server">

      <h3>Button CommandName Example</h3>

      Click on one of the command buttons.

      <br><br>
 
      <asp:Button id="Button1"
           Text="Sort Ascending"
           CommandName="Sort"
           CommandArgument="Ascending"
           OnCommand="CommandBtn_Click" 
           runat="server"/>

      &nbsp;

      <asp:Button id="Button2"
           Text="Sort Descending"
           CommandName="Sort"
           CommandArgument="Descending"
           OnCommand="CommandBtn_Click" 
           runat="server"/>

      <br><br>

      <asp:Button id="Button3"
           Text="Submit"
           CommandName="Submit"
           OnCommand="CommandBtn_Click" 
           runat="server"/>

      &nbsp;

      <asp:Button id="Button4"
           Text="Unknown Command Name"
           CommandName="UnknownName"
           CommandArgument="UnknownArgument"
           OnCommand="CommandBtn_Click" 
           runat="server"/>

      &nbsp;

      <asp:Button id="Button5"
           Text="Submit Unknown Command Argument"
           CommandName="Submit"
           CommandArgument="UnknownArgument"
           OnCommand="CommandBtn_Click" 
           runat="server"/>
       
      <br><br>

      <asp:Label id="Message" 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

参照

関連項目
Button クラス
Button メンバ
System.Web.UI.WebControls 名前空間
Command
OnCommand
CommandName
その他の技術情報
Button Web サーバーコントロール

このページでは「.NET Framework クラスライブラリリファレンス」からButton.CommandArgument プロパティを検索した結果を表示しています。
Weblioに収録されているすべての辞書からButton.CommandArgument プロパティを検索する場合は、下記のリンクをクリックしてください。

全ての辞書からButton.CommandArgument プロパティを検索

>> 「Button.CommandArgument プロパティ」を含む用語の索引
Button.CommandArgument プロパティのページへのリンク

Button.CommandArgument プロパティとは？わかりやすく解説

Button.CommandArgument プロパティ

「Button.CommandArgument プロパティ」の関連用語


	© 2024 Microsoft.All rights reserved.

Button.CommandArgument プロパティとは？ わかりやすく解説

Button.CommandArgument プロパティ

急上昇のことば

「Button.CommandArgument プロパティ」の関連用語

Button.CommandArgument プロパティとは？わかりやすく解説