CommandEventArgs.CommandArgument Property
Gets the argument for the command.
[Visual Basic] Public ReadOnly Property CommandArgument As Object [C#] public object CommandArgument {get;} [C++] public: __property Object* get_CommandArgument(); [JScript] public function get CommandArgument() : Object;
Property Value
A System.Object that contains the argument for the command.
Remarks
The CommandArgument can contain any string set by the programmer. The CommandArgument property complements the CommandName property by allowing you to provide any additional information for the command. For example, you can set the CommandName property to Sort and set the CommandArgument property to Ascending to specify a command to sort in ascending order.
Example
[Visual Basic, C#] The following example demonstrates how to use the CommandArgument property to determine supplemental information for the command to perform.
[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"/> <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"/> <asp:Button id="Button4" Text="Unknown Command Name" CommandName="UnknownName" CommandArgument="UnknownArgument" OnCommand="CommandBtn_Click" runat="server"/> <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> [C#] <%@ 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"/> <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"/> <asp:Button id="Button4" Text="Unknown Command Name" CommandName="UnknownName" CommandArgument="UnknownArgument" OnCommand="CommandBtn_Click" runat="server"/> <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>
[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button
in the upper-left corner of the page.
Requirements
Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family
See Also
CommandEventArgs Class | CommandEventArgs Members | System.Web.UI.WebControls Namespace | Button.CommandArgument | CommandArgument