This documentation is archived and is not being maintained.

LinkButton.CommandArgument Property

Gets or sets an optional argument passed to the Command event handler along with the associated CommandName property.

[Visual Basic]
Public Property CommandArgument As String
[C#]
public string CommandArgument {get; set;}
[C++]
public: __property String* get_CommandArgument();
public: __property void set_CommandArgument(String*);
[JScript]
public function get CommandArgument() : String;
public function set CommandArgument(String);

Property Value

An optional argument passed tp the Command event handler along with the associated CommandName property. The default value is String.Empty.

Remarks

Use the CommandArgument property to specify an argument that complements the CommandName property.

Note   The CommandArgument property is typically only used when the CommandName property is set.

The CommandArgument property complements the CommandName property by allowing you to provide any additional information for the command to perform. 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#, JScript] The following example demonstrates how to use the CommandArgument property to specify an optional argument that complements the command name for a LinkButton control.

[Visual Basic] 
<%@ Page Language="VB" AutoEventWireup="True" %>
<html>
<head>

   <script language="VB" runat="server">
     
      Sub LinkButton_Command(sender As Object, e As CommandEventArgs) 
         Label1.Text = "You chose: " & e.CommandName & " Item " & _
            e.CommandArgument
      End Sub
 
   </script>
 
</head>
<body>
 
   <form runat=server>
 
      <h3>LinkButton Command Event Example</h3>
  
      <asp:LinkButton id="LinkButton1" 
           Text="Order Item 10001"
           CommandName="Order" 
           CommandArgument="10001" 
           OnCommand="LinkButton_Command" 
           runat="server"/>
 
      <br>
  
      <asp:LinkButton id="LinkButton2" 
           Text="Order Item 10002"
           CommandName="Order" 
           CommandArgument="10002" 
           OnCommand="LinkButton_Command" 
           Runat="server"/>
 
      <br>
      <p>
 
      <asp:Label id="Label1" runat="server"/>
 
   </form>

</body>
</html>


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

   <script language="C#" runat="server">
     
      void LinkButton_Command(Object sender, CommandEventArgs e) 
      {
         Label1.Text = "You chose: " + e.CommandName + " Item " + e.CommandArgument;
      }
 
   </script>
 
</head>
<body>
 
   <form runat=server>
 
      <h3>LinkButton Command Event Example</h3>
  
      <asp:LinkButton id="LinkButton1" 
           Text="Order Item 10001"
           CommandName="Order" 
           CommandArgument="10001" 
           OnCommand="LinkButton_Command" 
           runat="server"/>
 
      <br>
  
      <asp:LinkButton id="LinkButton2" 
           Text="Order Item 10002"
           CommandName="Order" 
           CommandArgument="10002" 
           OnCommand="LinkButton_Command" 
           Runat="server"/>
 
      <br>
      <p>
 
      <asp:Label id="Label1" runat="server"/>
 
   </form>

</body>
</html>


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

   <script language="JSCRIPT" runat="server">
     
      function LinkButton_Command(sender : Object, e : CommandEventArgs){
         Label1.Text = "You chose: " + e.CommandName + " Item " + e.CommandArgument
      }
 
   </script>
 
</head>
<body>
 
   <form runat=server>
 
      <h3>LinkButton Command Event Example</h3>
  
      <asp:LinkButton id="LinkButton1" 
           Text="Order Item 10001"
           CommandName="Order" 
           CommandArgument="10001" 
           OnCommand="LinkButton_Command" 
           runat="server"/>
 
      <br>
  
      <asp:LinkButton id="LinkButton2" 
           Text="Order Item 10002"
           CommandName="Order" 
           CommandArgument="10002" 
           OnCommand="LinkButton_Command" 
           Runat="server"/>
 
      <br>
      <p>
 
      <asp:Label id="Label1" runat="server"/>
 
   </form>

</body>
</html>

[C++] No example is available for C++. To view a Visual Basic, C#, or JScript example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

See Also

LinkButton Class | LinkButton Members | System.Web.UI.WebControls Namespace | Command | OnCommand | CommandName

Show: