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.

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

public string CommandArgument { get; set; }
<asp:LinkButton CommandArgument="String" />

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.


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"
<html xmlns="" >
    <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;



   <form id="form1" runat="server">

      <h3>LinkButton Command Event Example</h3>

      <asp:LinkButton id="LinkButton1" 
           Text="Order Item 10001"

      <br />

      <asp:LinkButton id="LinkButton2" 
           Text="Order Item 10002"

      <br />
      <br />

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



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.