.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
Public Class ImageButton _
	Inherits [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_0_0_0%] _
	Implements [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_0_0_1%], [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_0_0_2%], [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_0_0_3%]
public class ImageButton : [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_1_0_0%], 
	[%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_1_0_1%], [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_1_0_2%], [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_1_0_3%]
public ref class ImageButton : public [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_2_0_0%], 
	[%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_2_0_1%], [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_2_0_2%], [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_2_0_3%]
type ImageButton =  
    class 
        inherit [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_3_0_0%] 
        interface [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_3_0_1%] 
        interface [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_3_0_2%] 
        interface [%$TOPIC/cz4k1tk6_en-us_VS_110_2_0_3_0_3%] 
    end
<asp:ImageButton />

The ImageButton type exposes the following members.

Constructors
  NameDescription
Public method ImageButtonInitializes a new instance of the ImageButton class.
Top
Properties
  NameDescription
Public property AccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
Protected property AdapterGets the browser-specific adapter for the control. (Inherited from Control.)
Public property AlternateTextGets or sets the alternate text displayed in the Image control when the image is unavailable. Browsers that support the ToolTips feature display this text as a ToolTip. (Inherited from Image.)
Public property AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public property AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public property BackColorGets or sets the background color of the Web server control. (Inherited from WebControl.)
Public property BindingContainerInfrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public property BorderColorGets or sets the border color of the Web control. (Inherited from WebControl.)
Public property BorderStyleGets or sets the border style of the Web server control. (Inherited from WebControl.)
Public property BorderWidthGets or sets the border width of the Web server control. (Inherited from WebControl.)
Public property CausesValidationGets or sets a value indicating whether validation is performed when the ImageButton control is clicked.
Protected property ChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public property ClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
Public property ClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.)
Protected property ClientIDSeparatorGets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Public property CommandArgumentGets or sets an optional argument that provides additional information about the CommandName property.
Public property CommandNameGets or sets the command name associated with the ImageButton control.
Protected property ContextGets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public property ControlsGets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.)
Public property ControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public property ControlStyleCreatedGets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.)
Public property CssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
Public property DataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.)
Public property DataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.)
Public property DescriptionUrlGets or sets the location to a detailed description for the image. (Inherited from Image.)
Protected property DesignModeGets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public property EnabledGets or sets a value indicating whether the ImageButton can be clicked to perform a post back to the server. (Overrides ImageEnabled.)
Public property EnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
Public property EnableViewStateGets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.)
Protected property EventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public property FontGets the font properties for the text associated with the control. (Inherited from Image.)
Public property ForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
Public property GenerateEmptyAlternateTextGets or sets a value indicating whether the control generates an alternate-text attribute for an empty string value. (Overrides ImageGenerateEmptyAlternateText.)
Public property HasAttributesGets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Protected property HasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Public property HeightGets or sets the height of the Web server control. (Inherited from WebControl.)
Public property IDGets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected property IdSeparatorInfrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Public property ImageAlignGets or sets the alignment of the Image control in relation to other elements on the Web page. (Inherited from Image.)
Public property ImageUrlGets or sets the URL that provides the path to an image to display in the Image control. (Inherited from Image.)
Protected property IsChildControlStateClearedGets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected property IsEnabledGets a value indicating whether the control is enabled. (Inherited from WebControl.)
Protected property IsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected property IsViewStateEnabledGets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Protected property LoadViewStateByIDGets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Public property NamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ControlID property value. (Inherited from Control.)
Public property OnClientClickGets or sets the client-side script that executes when an ImageButton control's Click event is raised.
Public property PageGets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public property ParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public property PostBackUrlGets or sets the URL of the page to post to from the current page when the ImageButton control is clicked.
Public property RenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.)
Public property SiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public property SkinIDGets or sets the skin to apply to the control. (Inherited from WebControl.)
Public property StyleGets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.)
Public property SupportsDisabledAttributeGets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false. (Overrides ImageSupportsDisabledAttribute.)
Public property TabIndexGets or sets the tab index of the Web server control. (Inherited from WebControl.)
Protected property TagKeyGets the HtmlTextWriterTag value that corresponds to the ImageButton control. (Overrides WebControlTagKey.)
Protected property TagNameGets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
Public property TemplateControlGets or sets a reference to the template that contains this control. (Inherited from Control.)
Public property TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Protected property TextInfrastructure. Gets or sets the value of the ImageButton control's AlternateText property.
Public property ToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
Public property UniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public property ValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control.)
Public property ValidationGroupGets or sets the group of controls for which the ImageButton control causes validation when it posts back to the server.
Protected property ViewStateGets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control.)
Protected property ViewStateIgnoresCaseGets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public property ViewStateModeGets or sets the view-state mode of this control. (Inherited from Control.)
Public property VisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
Public property WidthGets or sets the width of the Web server control. (Inherited from WebControl.)
Top
Methods
  NameDescription
Protected method AddAttributesToRenderAdds the attributes of an ImageButton to the output stream for rendering on the client. (Overrides ImageAddAttributesToRender(HtmlTextWriter).)
Protected method AddedControlCalled after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected method AddParsedSubObjectNotifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.)
Public method ApplyStyleCopies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl.)
Public method ApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Protected method BeginRenderTracingBegins design-time tracing of rendering data. (Inherited from Control.)
Protected method BuildProfileTreeInfrastructure. Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.)
Protected method ClearCachedClientIDInfrastructure. Sets the cached ClientID value to . (Inherited from Control.)
Protected method ClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected method ClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected method ClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from Control.)
Protected method ClearEffectiveClientIDModeInfrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.)
Public method CopyBaseAttributesCopies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method CreateChildControlsCalled by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control.)
Protected method CreateControlCollectionCreates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
Protected method CreateControlStyleCreates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl.)
Public method DataBindBinds a data source to the invoked server control and all its child controls. (Inherited from Control.)
Protected method DataBind(Boolean)Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.)
Protected method DataBindChildrenBinds a data source to the server control's child controls. (Inherited from Control.)
Public method DisposeEnables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Protected method EndRenderTracingEnds design-time tracing of rendering data. (Inherited from Control.)
Protected method EnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected method EnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Public method Equals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FindControl(String)Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
Protected method FindControl(String, Int32)Infrastructure. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control.)
Public method FocusSets input focus to a control. (Inherited from Control.)
Protected method GetDesignModeStateInfrastructure. Gets design-time data for a control. (Inherited from Control.)
Public method GetHashCodeServes as the default hash function. (Inherited from Object.)
Protected method GetPostBackOptionsCreates a PostBackOptions object that represents the ImageButton control's postback behavior.
Public method GetRouteUrl(Object)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public method GetRouteUrl(RouteValueDictionary)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public method GetRouteUrl(String, Object)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public method GetRouteUrl(String, RouteValueDictionary)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method GetUniqueIDRelativeToReturns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.)
Public method HasControlsDetermines if the server control contains any child controls. (Inherited from Control.)
Protected method HasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected method IsLiteralContentInfrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
Protected method LoadControlStateRestores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
Protected method LoadPostDataProcesses posted data for the ImageButton control.
Protected method LoadViewStateRestores view-state information from a previous request that was saved with the SaveViewState method. (Inherited from WebControl.)
Protected method MapPathSecureRetrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method MergeStyleCopies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method OnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.)
Protected method OnClickRaises the Click event and allows you to handle the Click event directly.
Protected method OnCommandRaises the Command event and allows you to handle the Command event directly.
Protected method OnDataBindingRaises the DataBinding event. (Inherited from Control.)
Protected method OnInitRaises the Init event. (Inherited from Control.)
Protected method OnLoadRaises the Load event. (Inherited from Control.)
Protected method OnPreRenderDetermines whether the image has been clicked prior to rendering on the client. (Overrides ControlOnPreRender(EventArgs).)
Protected method OnUnloadRaises the Unload event. (Inherited from Control.)
Protected method OpenFileGets a Stream used to read a file. (Inherited from Control.)
Protected method RaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected method RaisePostBackEventRaises events for the ImageButton control when it posts back to the server.
Protected method RaisePostDataChangedEventNotifies the ASP.NET application that the state of the ImageButton control has changed.
Protected method RemovedControlCalled after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected method RenderRenders the control to the specified HTML writer. (Inherited from WebControl.)
Public method RenderBeginTagRenders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method RenderChildrenOutputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.)
Protected method RenderContentsRenders the image control contents to the specified writer. (Inherited from Image.)
Public method RenderControl(HtmlTextWriter)Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter)Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
Public method RenderEndTagRenders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method ResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Public method ResolveClientUrlGets a URL that can be used by the browser. (Inherited from Control.)
Public method ResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected method SaveControlStateSaves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
Protected method SaveViewStateSaves any state that was modified after the TrackViewState method was invoked. (Inherited from WebControl.)
Protected method SetDesignModeStateSets design-time data for a control. (Inherited from Control.)
Public method SetRenderMethodDelegateInfrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public method SetTraceData(Object, Object)Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from Control.)
Public method SetTraceData(Object, Object, Object)Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. (Inherited from Control.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Protected method TrackViewStateCauses the control to track changes to its view state so they can be stored in the object's ViewState property. (Inherited from WebControl.)
Top
Events
  NameDescription
Public event ClickOccurs when the ImageButton is clicked.
Public event CommandOccurs when the ImageButton is clicked.
Public event DataBindingOccurs when the server control binds to a data source. (Inherited from Control.)
Public event DisposedOccurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.)
Public event InitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public event LoadOccurs when the server control is loaded into the Page object. (Inherited from Control.)
Public event PreRenderOccurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public event UnloadOccurs when the server control is unloaded from memory. (Inherited from Control.)
Top
Extension Methods
  NameDescription
Public Extension Method FindDataSourceControlReturns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension Method FindFieldTemplateReturns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension Method FindMetaTableReturns the metatable object for the containing data control. (Defined by DynamicDataExtensions.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method IAttributeAccessorGetAttributeInfrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.)
Explicit interface implemetation Private method IAttributeAccessorSetAttributeSets an attribute of the Web control to the specified name and value. (Inherited from WebControl.)
Explicit interface implemetation Private event IButtonControlClickInfrastructure. For a description of this member, see the IButtonControlClick event.
Explicit interface implemetation Private property IButtonControlTextInfrastructure. For a description of this member, see IButtonControlText.
Explicit interface implemetation Private property IControlBuilderAccessorControlBuilderFor a description of this member, see IControlBuilderAccessorControlBuilder. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessorGetDesignModeStateFor a description of this member, see IControlDesignerAccessorGetDesignModeState. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessorSetDesignModeStateFor a description of this member, see IControlDesignerAccessorSetDesignModeState. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessorSetOwnerControlInfrastructure. For a description of this member, see IControlDesignerAccessorSetOwnerControl. (Inherited from Control.)
Explicit interface implemetation Private property IControlDesignerAccessorUserDataFor a description of this member, see IControlDesignerAccessorUserData. (Inherited from Control.)
Explicit interface implemetation Private property IDataBindingsAccessorDataBindingsFor a description of this member, see IDataBindingsAccessorDataBindings. (Inherited from Control.)
Explicit interface implemetation Private property IDataBindingsAccessorHasDataBindingsFor a description of this member, see IDataBindingsAccessorHasDataBindings. (Inherited from Control.)
Explicit interface implemetation Private property IExpressionsAccessorExpressionsFor a description of this member, see IExpressionsAccessorExpressions. (Inherited from Control.)
Explicit interface implemetation Private property IExpressionsAccessorHasExpressionsFor a description of this member, see IExpressionsAccessorHasExpressions. (Inherited from Control.)
Explicit interface implemetation Private method IParserAccessorAddParsedSubObjectFor a description of this member, see IParserAccessorAddParsedSubObject. (Inherited from Control.)
Explicit interface implemetation Private method IPostBackDataHandlerLoadPostDataInfrastructure. For a description of this member, see IPostBackDataHandlerLoadPostData.
Explicit interface implemetation Private method IPostBackDataHandlerRaisePostDataChangedEventInfrastructure. For a description of this member, see IPostBackDataHandlerRaisePostDataChangedEvent.
Explicit interface implemetation Private method IPostBackEventHandlerRaisePostBackEventInfrastructure. For a description of this member, see IPostBackEventHandlerRaisePostBackEvent.
Top
Remarks

In this topic:

  • Introduction

  • Determining Where the User Clicked

  • ImageButton Controls and Validation

  • Accessibility

  • Declarative Syntax

Introduction

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.

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.

Using the ImageButton control is similar to using the ASP.NET Button control. For more information, see Button Web Server Controls Content Map. and the class overview for the Button control.

Determining Where the User 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.

ImageButton Controls and Validation

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

For information about how to configure this control so that it generates markup that conforms to accessibility standards, see Accessibility in Visual Studio and ASP.NET and ASP.NET Controls and Accessibility.

Declarative Syntax

<asp:ImageButton
    AccessKey="string"
    AlternateText="string"
    BackColor="color name|#dddddd"
    BorderColor="color name|#dddddd"
    BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
        Inset|Outset"
    BorderWidth="size"
    CausesValidation="True|False"
    CommandArgument="string"
    CommandName="string"
    CssClass="string"
    DescriptionUrl="uri"
    Enabled="True|False"
    EnableTheming="True|False"
    EnableViewState="True|False"
    ForeColor="color name|#dddddd"
    Height="size"
    ID="string"
    ImageAlign="NotSet|Left|Right|Baseline|Top|Middle|Bottom|
        AbsBottom|AbsMiddle|TextTop"
    ImageUrl="uri"
    OnClick="Click event handler"
    OnClientClick="string"
    OnCommand="Command event handler"
    OnDataBinding="DataBinding event handler"
    OnDisposed="Disposed event handler"
    OnInit="Init event handler"
    OnLoad="Load event handler"
    OnPreRender="PreRender event handler"
    OnUnload="Unload event handler"
    PostBackUrl="uri"
    runat="server"
    SkinID="string"
    Style="string"
    TabIndex="integer"
    ToolTip="string"
    ValidationGroup="string"
    Visible="True|False"
    Width="size"
/>
Examples

A Visual Studio Web site project with source code is available to accompany this topic: Download.

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

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 Forms Page Code Model.

<%@ 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 xmlns="http://www.w3.org/1999/xhtml" >
<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 xmlns="http://www.w3.org/1999/xhtml" >
<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>
Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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.