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)

virtual property String^ CommandArgument {
	String^ get () sealed;
	void set (String^ value) sealed;
/** @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 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 Introduction to ASP.NET Themes.

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