LinkButton.CommandName Property (System.Web.UI.WebControls)

CommandName Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

LinkButton..::.CommandName Property

Gets or sets the command name associated with the LinkButton control. This value is passed to the Command event handler along with the CommandArgument property.

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

Syntax

Visual Basic (Declaration)

<ThemeableAttribute(False)> _
Public Property CommandName As String

Visual Basic (Usage)

Dim instance As LinkButton
Dim value As String

value = instance.CommandName

instance.CommandName = value

[ThemeableAttribute(false)]
public string CommandName { get; set; }

Visual C++

[ThemeableAttribute(false)]
public:
virtual property String^ CommandName {
    String^ get () sealed;
    void set (String^ value) sealed;
}

JScript

public final function get CommandName () : String
public final function set CommandName (value : String)

ASP.NET

<asp:LinkButton CommandName="String" />

Property Value

Type: System..::.String
The command name of the LinkButton control. The default value is String..::.Empty.

Implements

IButtonControl..::.CommandName

Remarks

When you have multiple LinkButton controls on a Web page, use the CommandName property to specify or determine the command name associated with the LinkButton control clicked. You can set the CommandName property with any string that identifies the command to perform. You can then programmatically determine the command name of the LinkButton control and perform the appropriate actions.

Additional information about the command, such as an Ascending sort order, can be specified by using the CommandArgument property.

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

Examples

The following example demonstrates how to use the CommandName property to specify a command name for a LinkButton control.

Visual Basic

<%@ Page Language="VB" AutoEventWireup="True" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html  >
<head>
    <title>LinkButton Command Event Example</title>
<script language="VB" runat="server">

      Sub LinkButton_Command(sender As Object, e As CommandEventArgs) 
         Label1.Text = "You chose: " & e.CommandName & " Item " & _
            e.CommandArgument
      End Sub

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

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

JScript

<%@ Page Language="JScript" AutoEventWireup="True" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html  >
<head>
    <title>LinkButton Command Event Example</title>
<script language="JSCRIPT" runat="server">

      function LinkButton_Command(sender : Object, e : CommandEventArgs){
         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>

Platforms

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.

Version Information

.NET Framework

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

Reference

LinkButton Class

LinkButton Members

System.Web.UI.WebControls Namespace

Command

OnCommand

CommandArgument

Other Resources

Button Web Server Controls Overview