This documentation is archived and is not being maintained.

ImageButton.CommandName Property

Gets or sets the command name associated with the ImageButton control.

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

[ThemeableAttribute(false)] 
public string CommandName { get; set; }
/** @property */
public final String get_CommandName ()

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

public final function get CommandName () : String

public final function set CommandName (value : String)

Not applicable.

Property Value

The command name associated with the ImageButton control. The default value is String.Empty.

Use this property to specify the command to perform when the ImageButton control is clicked, such as Sort, Cancel, or Edit. This allows multiple ImageButton controls to be placed on the same Web page. The value in this property can then be programmatically identified in the OnCommand event handler to determine the appropriate action to perform when each ImageButton control is clicked.

Supplemental information about the command, such as specifying ascending sort order, can be included by using the CommandArgument property.

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 CommandName property to associate a command name with an ImageButton control.

NoteNote:

The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see ASP.NET Web Page Code Model.

<%@ 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 xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>ImageButton CommandName Sample</title>
<script language="C#" runat="server">

      void ImageButton_Command(object sender, CommandEventArgs e) 
      {
         if (e.CommandName == "Sort")
            Label1.Text = "You clicked the Sort Button";
         else
            Label1.Text = "You clicked the Edit Button";
      }

   </script>

</head>

<body>

   <form id="form1" runat="server">

      <h3>ImageButton CommandName Sample</h3>

      Click an image.<br /><br />

      <asp:ImageButton id="imagebutton1" runat="server"
           AlternateText="Sort"
           ImageUrl="images/pict1.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"/>

      <asp:ImageButton id="imagebutton2" runat="server"
           AlternateText="Edit"
           ImageUrl="images/pict2.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Edit"/>

      <br /><br />
    
      <asp:label id="Label1" runat="server"/>

   </form>

</body>
</html>


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