ImageButton Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A control that displays an image and responds to mouse clicks on the image.
public ref class ImageButton : System::Web::UI::WebControls::Image, System::Web::UI::IPostBackDataHandler, System::Web::UI::IPostBackEventHandler
public ref class ImageButton : System::Web::UI::WebControls::Image, System::Web::UI::IPostBackDataHandler, System::Web::UI::IPostBackEventHandler, System::Web::UI::WebControls::IButtonControl
public class ImageButton : System.Web.UI.WebControls.Image, System.Web.UI.IPostBackDataHandler, System.Web.UI.IPostBackEventHandler
public class ImageButton : System.Web.UI.WebControls.Image, System.Web.UI.IPostBackDataHandler, System.Web.UI.IPostBackEventHandler, System.Web.UI.WebControls.IButtonControl
type ImageButton = class
inherit Image
interface IPostBackDataHandler
interface IPostBackEventHandler
type ImageButton = class
inherit Image
interface IPostBackDataHandler
interface IPostBackEventHandler
interface IButtonControl
Public Class ImageButton
Inherits Image
Implements IPostBackDataHandler, IPostBackEventHandler
Public Class ImageButton
Inherits Image
Implements IButtonControl, IPostBackDataHandler, IPostBackEventHandler
- Inheritance
- Implements
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.
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 Forms 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 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>
<%@ 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>
Remarks
In this topic:
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"
/>
Constructors
ImageButton() |
Initializes a new instance of the ImageButton class. |
Properties
AccessKey |
Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl) |
Adapter |
Gets the browser-specific adapter for the control. (Inherited from Control) |
AlternateText |
Gets 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) |
AppRelativeTemplateSourceDirectory |
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control) |
Attributes |
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl) |
BackColor |
Gets or sets the background color of the Web server control. (Inherited from WebControl) |
BindingContainer |
Gets the control that contains this control's data binding. (Inherited from Control) |
BorderColor |
Gets or sets the border color of the Web control. (Inherited from WebControl) |
BorderStyle |
Gets or sets the border style of the Web server control. (Inherited from WebControl) |
BorderWidth |
Gets or sets the border width of the Web server control. (Inherited from WebControl) |
CausesValidation |
Gets or sets a value indicating whether validation is performed when the ImageButton control is clicked. |
ChildControlsCreated |
Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control) |
ClientID |
Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control) |
ClientIDMode |
Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control) |
ClientIDSeparator |
Gets a character value representing the separator character used in the ClientID property. (Inherited from Control) |
CommandArgument |
Gets or sets an optional argument that provides additional information about the CommandName property. |
CommandName |
Gets or sets the command name associated with the ImageButton control. |
Context |
Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control) |
Controls |
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control) |
ControlStyle |
Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl) |
ControlStyleCreated |
Gets 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) |
CssClass |
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl) |
DataItemContainer |
Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control) |
DataKeysContainer |
Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control) |
DescriptionUrl |
Gets or sets the location to a detailed description for the image. (Inherited from Image) |
DesignMode |
Gets a value indicating whether a control is being used on a design surface. (Inherited from Control) |
Enabled |
Gets or sets a value indicating whether the ImageButton can be clicked to perform a post back to the server. |
Enabled |
Gets or sets a value indicating whether the control is enabled. (Inherited from Image) |
EnableTheming |
Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl) |
EnableViewState |
Gets 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) |
Events |
Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control) |
Font |
Gets the font properties for the text associated with the control. (Inherited from Image) |
ForeColor |
Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl) |
GenerateEmptyAlternateText |
Gets or sets a value indicating whether the control generates an alternate-text attribute for an empty string value. |
GenerateEmptyAlternateText |
Gets or sets a value indicating whether the control generates an alternate text attribute for an empty string value. (Inherited from Image) |
HasAttributes |
Gets a value indicating whether the control has attributes set. (Inherited from WebControl) |
HasChildViewState |
Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control) |
Height |
Gets or sets the height of the Web server control. (Inherited from WebControl) |
ID |
Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control) |
IdSeparator |
Gets the character used to separate control identifiers. (Inherited from Control) |
ImageAlign |
Gets or sets the alignment of the Image control in relation to other elements on the Web page. (Inherited from Image) |
ImageUrl |
Gets or sets the URL that provides the path to an image to display in the Image control. (Inherited from Image) |
IsChildControlStateCleared |
Gets a value indicating whether controls contained within this control have control state. (Inherited from Control) |
IsEnabled |
Gets a value indicating whether the control is enabled. (Inherited from WebControl) |
IsTrackingViewState |
Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control) |
IsViewStateEnabled |
Gets a value indicating whether view state is enabled for this control. (Inherited from Control) |
LoadViewStateByID |
Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control) |
NamingContainer |
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control) |
OnClientClick |
Gets or sets the client-side script that executes when an ImageButton control's Click event is raised. |
Page |
Gets a reference to the Page instance that contains the server control. (Inherited from Control) |
Parent |
Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control) |
PostBackUrl |
Gets or sets the URL of the page to post to from the current page when the ImageButton control is clicked. |
RenderingCompatibility |
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control) |
Site |
Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control) |
SkinID |
Gets or sets the skin to apply to the control. (Inherited from WebControl) |
Style |
Gets 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) |
SupportsDisabledAttribute |
Gets a value that indicates whether the control should set the |
SupportsDisabledAttribute |
Gets a value that indicates whether the control should set the |
TabIndex |
Gets or sets the tab index of the Web server control. (Inherited from WebControl) |
TagKey |
Gets the HtmlTextWriterTag value that corresponds to the ImageButton control. |
TagName |
Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl) |
TemplateControl |
Gets or sets a reference to the template that contains this control. (Inherited from Control) |
TemplateSourceDirectory |
Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control) |
Text |
Gets or sets the value of the ImageButton control's AlternateText property. |
ToolTip |
Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl) |
UniqueID |
Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control) |
ValidateRequestMode |
Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control) |
ValidationGroup |
Gets or sets the group of controls for which the ImageButton control causes validation when it posts back to the server. |
ViewState |
Gets 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) |
ViewStateIgnoresCase |
Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control) |
ViewStateMode |
Gets or sets the view-state mode of this control. (Inherited from Control) |
Visible |
Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control) |
Width |
Gets or sets the width of the Web server control. (Inherited from WebControl) |
Methods
AddAttributesToRender(HtmlTextWriter) |
Adds the attributes of an ImageButton to the output stream for rendering on the client. |
AddedControl(Control, Int32) |
Called after a child control is added to the Controls collection of the Control object. (Inherited from Control) |
AddParsedSubObject(Object) |
Notifies 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) |
ApplyStyle(Style) |
Copies 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) |
ApplyStyleSheetSkin(Page) |
Applies the style properties defined in the page style sheet to the control. (Inherited from Control) |
BeginRenderTracing(TextWriter, Object) |
Begins design-time tracing of rendering data. (Inherited from Control) |
BuildProfileTree(String, Boolean) |
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) |
ClearCachedClientID() |
Sets the cached ClientID value to |
ClearChildControlState() |
Deletes the control-state information for the server control's child controls. (Inherited from Control) |
ClearChildState() |
Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control) |
ClearChildViewState() |
Deletes the view-state information for all the server control's child controls. (Inherited from Control) |
ClearEffectiveClientIDMode() |
Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control) |
CopyBaseAttributes(WebControl) |
Copies 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) |
CreateChildControls() |
Called 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) |
CreateControlCollection() |
Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control) |
CreateControlStyle() |
Creates 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) |
DataBind() |
Binds a data source to the invoked server control and all its child controls. (Inherited from Control) |
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) |
DataBindChildren() |
Binds a data source to the server control's child controls. (Inherited from Control) |
Dispose() |
Enables a server control to perform final clean up before it is released from memory. (Inherited from Control) |
EndRenderTracing(TextWriter, Object) |
Ends design-time tracing of rendering data. (Inherited from Control) |
EnsureChildControls() |
Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control) |
EnsureID() |
Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control) |
Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
FindControl(String) |
Searches the current naming container for a server control with the specified |
FindControl(String, Int32) |
Searches the current naming container for a server control with the specified |
Focus() |
Sets input focus to a control. (Inherited from Control) |
GetDesignModeState() |
Gets design-time data for a control. (Inherited from Control) |
GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
GetPostBackOptions() |
Creates a PostBackOptions object that represents the ImageButton control's postback behavior. |
GetRouteUrl(Object) |
Gets the URL that corresponds to a set of route parameters. (Inherited from Control) |
GetRouteUrl(RouteValueDictionary) |
Gets the URL that corresponds to a set of route parameters. (Inherited from Control) |
GetRouteUrl(String, Object) |
Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control) |
GetRouteUrl(String, RouteValueDictionary) |
Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control) |
GetType() |
Gets the Type of the current instance. (Inherited from Object) |
GetUniqueIDRelativeTo(Control) |
Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control) |
HasControls() |
Determines if the server control contains any child controls. (Inherited from Control) |
HasEvents() |
Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control) |
IsLiteralContent() |
Determines if the server control holds only literal content. (Inherited from Control) |
LoadControlState(Object) |
Restores control-state information from a previous page request that was saved by the SaveControlState() method. (Inherited from Control) |
LoadPostData(String, NameValueCollection) |
Processes posted data for the ImageButton control. |
LoadViewState(Object) |
Restores view-state information from a previous request that was saved with the SaveViewState() method. (Inherited from WebControl) |
MapPathSecure(String) |
Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control) |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
MergeStyle(Style) |
Copies 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) |
OnBubbleEvent(Object, EventArgs) |
Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control) |
OnClick(ImageClickEventArgs) |
Raises the Click event and allows you to handle the Click event directly. |
OnCommand(CommandEventArgs) |
Raises the Command event and allows you to handle the Command event directly. |
OnDataBinding(EventArgs) |
Raises the DataBinding event. (Inherited from Control) |
OnInit(EventArgs) |
Raises the Init event. (Inherited from Control) |
OnLoad(EventArgs) |
Raises the Load event. (Inherited from Control) |
OnPreRender(EventArgs) |
Determines whether the image has been clicked prior to rendering on the client. |
OnUnload(EventArgs) |
Raises the Unload event. (Inherited from Control) |
OpenFile(String) |
Gets a Stream used to read a file. (Inherited from Control) |
RaiseBubbleEvent(Object, EventArgs) |
Assigns any sources of the event and its information to the control's parent. (Inherited from Control) |
RaisePostBackEvent(String) |
Raises events for the ImageButton control when it posts back to the server. |
RaisePostDataChangedEvent() |
Notifies the ASP.NET application that the state of the ImageButton control has changed. |
RemovedControl(Control) |
Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control) |
Render(HtmlTextWriter) |
Renders the control to the specified HTML writer. (Inherited from WebControl) |
RenderBeginTag(HtmlTextWriter) |
Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl) |
RenderChildren(HtmlTextWriter) |
Outputs 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) |
RenderContents(HtmlTextWriter) |
Renders the image control contents to the specified writer. (Inherited from Image) |
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) |
RenderControl(HtmlTextWriter, ControlAdapter) |
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control) |
RenderEndTag(HtmlTextWriter) |
Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl) |
ResolveAdapter() |
Gets the control adapter responsible for rendering the specified control. (Inherited from Control) |
ResolveClientUrl(String) |
Gets a URL that can be used by the browser. (Inherited from Control) |
ResolveUrl(String) |
Converts a URL into one that is usable on the requesting client. (Inherited from Control) |
SaveControlState() |
Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control) |
SaveViewState() |
Saves any state that was modified after the TrackViewState() method was invoked. (Inherited from WebControl) |
SetDesignModeState(IDictionary) |
Sets design-time data for a control. (Inherited from Control) |
SetRenderMethodDelegate(RenderMethod) |
Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control) |
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) |
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) |
ToString() |
Returns a string that represents the current object. (Inherited from Object) |
TrackViewState() |
Causes the control to track changes to its view state so they can be stored in the object's ViewState property. (Inherited from WebControl) |
Events
Click |
Occurs when the ImageButton is clicked. |
Command |
Occurs when the ImageButton is clicked. |
DataBinding |
Occurs when the server control binds to a data source. (Inherited from Control) |
Disposed |
Occurs 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) |
Init |
Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control) |
Load |
Occurs when the server control is loaded into the Page object. (Inherited from Control) |
PreRender |
Occurs after the Control object is loaded but prior to rendering. (Inherited from Control) |
Unload |
Occurs when the server control is unloaded from memory. (Inherited from Control) |
Explicit Interface Implementations
Extension Methods
FindDataSourceControl(Control) |
Returns the data source that is associated with the data control for the specified control. |
FindFieldTemplate(Control, String) |
Returns the field template for the specified column in the specified control's naming container. |
FindMetaTable(Control) |
Returns the metatable object for the containing data control. |