ImageButton Class (System.Web.UI.WebControls)

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

ImageButton Class

A control that displays an image and responds to mouse clicks on the image.

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

Syntax

Visual Basic (Declaration)

<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class ImageButton _
    Inherits Image _
    Implements IPostBackDataHandler, IPostBackEventHandler, IButtonControl

Visual Basic (Usage)

Dim instance As ImageButton

[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public class ImageButton : Image, 
    IPostBackDataHandler, IPostBackEventHandler, IButtonControl

Visual C++

[AspNetHostingPermissionAttribute(SecurityAction::LinkDemand, Level = AspNetHostingPermissionLevel::Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction::InheritanceDemand, Level = AspNetHostingPermissionLevel::Minimal)]
public ref class ImageButton : public Image, 
    IPostBackDataHandler, IPostBackEventHandler, IButtonControl

JScript

public class ImageButton extends Image implements IPostBackDataHandler, IPostBackEventHandler, IButtonControl

ASP.NET

<asp:ImageButton />

Remarks

Use the ImageButton control to display an image that responds to mouse clicks.

Both the Click and Command events are raised when the ImageButton control is clicked.

By using the OnClick event handler, you can programmatically determine the coordinates where the image is clicked. You can then code a response, based on the values of the coordinates. Note that the origin (0, 0) is located at the upper left corner of the image.

You can use the OnCommand event handler to make the ImageButton control behave like a Command button. A command name can be associated with the control by using the CommandName property. This allows multiple ImageButton controls to be placed on the same Web page. The value of the CommandName property can then be programmatically identified in the OnCommand event handler to determine the appropriate action to perform when each ImageButton control is clicked. The CommandArgument property can also be used to pass additional information about the command, such as specifying ascending order.

By default, page validation is performed when an ImageButton control is clicked. Page validation determines whether the input controls associated with a validation control on the page all pass the validation rules specified by the validation control. To prevent page validation from occurring, set the CausesValidation property to false.

Accessibility

The markup rendered by default for this control might not conform to accessibility standards such as the Web Content Accessibility Guidelines 1.0 (WCAG) priority 1 guidelines. For details about accessibility support for this control, see ASP.NET Controls and Accessibility.

Topic	Location
How to: Add a Login Button to an ASP.NET Web Page	Building ASP .NET Web Applications
How to: Add a Login Button to an ASP.NET Web Page	Building ASP .NET Web Applications
How to: Add a Login Button to an ASP.NET Web Page	Building ASP .NET Web Applications in Visual Studio
How to: Add Button Web Server Controls to a Web Forms Page	Building ASP .NET Web Applications in Visual Studio
How to: Add Button Web Server Controls to a Web Forms Page	Building ASP .NET Web Applications
How to: Add Button Web Server Controls to a Web Forms Page	Building ASP .NET Web Applications
How to: Add Button Web Server Controls to a Web Forms Page (Visual Studio)	Building ASP .NET Web Applications in Visual Studio
How to: Add ImageButton Web Server Controls to a Web Forms Page	Building ASP .NET Web Applications in Visual Studio
How to: Add ImageButton Web Server Controls to a Web Forms Page	Building ASP .NET Web Applications
How to: Add ImageButton Web Server Controls to a Web Forms Page	Building ASP .NET Web Applications
How to: Add ImageButton Web Server Controls to a Web Forms Page (Visual Studio)	Building ASP .NET Web Applications in Visual Studio
How to: Determine Coordinates in an ImageButton Web Server Control	Building ASP .NET Web Applications
How to: Determine Coordinates in an ImageButton Web Server Control	Building ASP .NET Web Applications
How to: Determine Coordinates in an ImageButton Web Server Control	Building ASP .NET Web Applications in Visual Studio
How to: Respond to Button Events in Data-Bound Controls	Building ASP .NET Web Applications
How to: Respond to Button Events in Data-Bound Controls	Building ASP .NET Web Applications
How to: Respond to Button Events in Data-Bound Controls	Building ASP .NET Web Applications in Visual Studio
How to: Respond to Button Events in DataList or Repeater Items	Building ASP .NET Web Applications in Visual Studio
How to: Respond to Button Events in DataList, Repeater, or GridView Items	Building ASP .NET Web Applications
How to: Respond to Button Events in DataList, Repeater, or GridView Items	Building ASP .NET Web Applications
How to: Respond to Button Web Server Control Events	Building ASP .NET Web Applications
How to: Respond to Button Web Server Control Events	Building ASP .NET Web Applications
How to: Respond to Button Web Server Control Events	Building ASP .NET Web Applications in Visual Studio
How to: Respond to Button Web Server Control Events in Client Script	Building ASP .NET Web Applications
How to: Respond to Button Web Server Control Events in Client Script	Building ASP .NET Web Applications
How to: Respond to Button Web Server Control Events in Client Script	Building ASP .NET Web Applications in Visual Studio
How to: Set Focus on ASP.NET Web Server Controls	Building ASP .NET Web Applications
How to: Set Focus on ASP.NET Web Server Controls	Building ASP .NET Web Applications
How to: Set Focus on ASP.NET Web Server Controls	Building ASP .NET Web Applications in Visual Studio
Walkthrough: Creating and Using ASP.NET Master Pages in Visual Web Developer	Building ASP .NET Web Applications in Visual Studio
Walkthrough: Creating and Using ASP.NET Master Pages in Visual Web Developer	Building Applications with Visual Web Developer
Walkthrough: Data Binding to a Custom Business Object	Building ASP .NET Web Applications in Visual Studio
Walkthrough: Data Binding to a Custom Business Object	Building ASP .NET Web Applications in Visual Studio

Examples

The following code example demonstrates how to create an ImageButton control that displays the coordinates at which an image is clicked.

Note:
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.

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>ImageButton Sample</title>
<script language="VB" runat="server">

      Sub ImageButton_Click(sender As Object, e As ImageClickEventArgs) 
         Label1.Text = "You clicked the ImageButton control at the coordinates: (" & _ 
                       e.X.ToString() & ", " & e.Y.ToString() & ")"
      End Sub

   </script>

</head>

<body>

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

      <h3>ImageButton Sample</h3>

      Click anywhere on the image.<br /><br />

      <asp:ImageButton id="imagebutton1" runat="server"
           AlternateText="ImageButton 1"
           ImageAlign="left"
           ImageUrl="images/pict.jpg"
           OnClick="ImageButton_Click"/>

      <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>ImageButton Sample</title>
<script language="C#" runat="server">

      void ImageButton_Click(object sender, ImageClickEventArgs e) 
      {
         Label1.Text = "You clicked the ImageButton control at the coordinates: (" + 
                       e.X.ToString() + ", " + e.Y.ToString() + ")";
      }

   </script>

</head>

<body>

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

      <h3>ImageButton Sample</h3>

      Click anywhere on the image.<br /><br />

      <asp:ImageButton id="imagebutton1" runat="server"
           AlternateText="ImageButton 1"
           ImageAlign="left"
           ImageUrl="images/pict.jpg"
           OnClick="ImageButton_Click"/>

      <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>ImageButton Sample</title>
<script language="JSCRIPT" runat="server">

      function ImageButton_Click(sender : Object, e : ImageClickEventArgs) {
         Label1.Text = "You clicked the ImageButton control at the coordinates: (" + e.X.ToString() + ", " + e.Y.ToString() + ")"
      }

   </script>

</head>

<body>

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

      <h3>ImageButton Sample</h3>

      Click anywhere on the image.<br /><br />

      <asp:ImageButton id="imagebutton1" runat="server"
           AlternateText="ImageButton 1"
           ImageAlign="left"
           ImageUrl="images/pict.jpg"
           OnClick="ImageButton_Click"/>

      <br /><br />

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

   </form>

</body>
</html>

Permissions

AspNetHostingPermission
for operating in a hosted environment. Demand value: LinkDemand. Permission value: Minimal.
AspNetHostingPermission
for operating in a hosted environment. Demand value: InheritanceDemand. Permission value: Minimal.

Inheritance Hierarchy

System..::.Object
  System.Web.UI..::.Control
    System.Web.UI.WebControls..::.WebControl
      System.Web.UI.WebControls..::.Image
        System.Web.UI.WebControls..::.ImageButton

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, 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