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; }
/** @property */
public final String get_CommandArgument ()

/** @property */
public final void set_CommandArgument (String value)

public final function get CommandArgument () : String

public final function set CommandArgument (value : String)

Not applicable.

Property Value

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 Introduction to ASP.NET Themes.

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"/>


Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0