This documentation is archived and is not being maintained.

LinkButton.OnCommand Method

Raises the Command event of the LinkButton control.

[Visual Basic]
Protected Overridable Sub OnCommand( _
   ByVal e As CommandEventArgs _
)
[C#]
protected virtual void OnCommand(
 CommandEventArgs e
);
[C++]
protected: virtual void OnCommand(
 CommandEventArgs* e
);
[JScript]
protected function OnCommand(
   e : CommandEventArgs
);

Parameters

e
A CommandEventArgs that contains the event data.

Remarks

The Command event is raised when the LinkButton control is clicked. This event is commonly used when a command name, such as Sort, is associated with the LinkButton control. This allows you to create multiple LinkButton controls on a Web page and programmatically determine which LinkButton control is clicked.

Note   The Command event is raised through the control hierarchy in the form of the BubbleEvent.

Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

The OnCommand method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors:  When overriding OnCommand in a derived class, be sure to call the base class's OnCommand method so that registered delegates receive the event.

Example

[Visual Basic, C#, JScript] The following example demonstrates how to specify and code a handle for the Command event to display which LinkButton control is clicked.

[Visual Basic] 
<%@ Page Language="VB" AutoEventWireup="True" %>
<html>
<head>

   <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 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>
      <p>
 
      <asp:Label id="Label1" runat="server"/>
 
   </form>

</body>
</html>


[C#] 
<%@ Page Language="C#" AutoEventWireup="True" %>
<html>
<head>

   <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 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>
      <p>
 
      <asp:Label id="Label1" runat="server"/>
 
   </form>

</body>
</html>


[JScript] 
<%@ Page Language="JScript" AutoEventWireup="True" %>
<html>
<head>

   <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 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>
      <p>
 
      <asp:Label id="Label1" runat="server"/>
 
   </form>

</body>
</html>

[C++] No example is available for C++. To view a Visual Basic, C#, or JScript example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

See Also

LinkButton Class | LinkButton Members | System.Web.UI.WebControls Namespace | Command | CommandEventArgs

Show: