CommandArgument Property
Collapse the table of content
Expand the table of content

LinkButton.CommandArgument Property

 

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

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

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

Property Value

Type: System.String

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

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

System_CAPS_noteNote

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 about 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.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

The following example demonstrates how to use the CommandArgument property to specify an optional argument that complements the command name for a LinkButton control.

<%@ Page Language="C#" AutoEventWireup="True" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>LinkButton Command Event Example</title>
<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 id="form1" 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 />
      <br />

      <asp:Label id="Label1" runat="server"/>

   </form>

</body>
</html>

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft