This documentation is archived and is not being maintained.

Button.CommandArgument Property

Gets or sets an optional parameter passed to the Command event along with the associated CommandName.

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

public final function get CommandArgument () : String 
public final function set CommandArgument (value : String)
<asp:Button CommandArgument="String" />

Property Value

Type: System.String
An optional parameter passed to the Command event along with the associated CommandName. The default value is String.Empty.



Use the CommandArgument property to specify a parameter that compliments the CommandName property.


Although you can set the CommandArgument property by itself, it is normally only used when the CommandName property is also set.

The CommandArgument property complements the CommandName property by allowing you to provide additional information about the command to perform. For example, if you set the CommandName property to Sort and the CommandArgument property to Ascending, you 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 Overview.

The following code example demonstrates how to use the CommandArgument property to create a Button control that sorts a list in ascending order.

No code example is currently available or this language may not be supported.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

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