This topic has not yet been rated - Rate this topic

ImageClickEventArgs Class

.NET Framework 4.5

Provides data for any events that occur when a user clicks an image-based ASP.NET server control, such as the HtmlInputImage or ImageButton server controls. This class cannot be inherited.

Inheritance Hierarchy

System.Object
System.EventArgs
System.Web.UI.ImageClickEventArgs

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

Syntax

C++

public sealed class ImageClickEventArgs : EventArgs

The ImageClickEventArgs type exposes the following members.

Constructors

	Name	Description
	ImageClickEventArgs(Int32, Int32)	Initializes a new instance of the ImageClickEventArgs class using the x and y parameters.
	ImageClickEventArgs(Int32, Int32, Double, Double)	Initializes a new instance of the ImageClickEventArgs class using the x, y, xRaw, and yRaw parameters.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	X	An integer that represents the x-coordinate where a user clicked an image-based ASP.NET server control.
	XRaw	An integer that represents the raw x-coordinate where a user clicked an image-based ASP.NET server control.
	Y	An integer that represents the y-coordinate where a user clicked an image-based ASP.NET server control.
	YRaw	An integer that represents the raw y-coordinate where a user clicked an image-based ASP.NET server control.

Top

Remarks

This class passes the location where a user clicked an HtmlInputImage server control or an ImageButton Web server control. Clicking an HtmlInputImage server control causes a ServerClick event to occur, while clicking an ImageButton server control causes a Click event to occur. You can then use event handlers to programmatically respond to the event based on the value of these coordinates.

Note
The origin coordinates (0,0) are located at the upper left corner of the image.

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

Examples

The following code example demonstrates an ASP.NET page that uses the information provided by this class to display the coordinates of a user's click on an image.

// Define the event handler that uses coordinate information through ImageClickEventArgs.
void ImageButton_Click(object sender, ImageClickEventArgs e) 
{
   Label1.Text = "You clicked the ImageButton control at the coordinates: (" + 
                 e.X.ToString() + ", " + e.Y.ToString() + ")";
}

Version Information

.NET Framework

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

Platforms

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.

Reference

System.Web.UI Namespace

ImageClickEventHandler

Other Resources

Raising an Event

Events and Delegates

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)