HotSpotMode Enum
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.
public enum class HotSpotModepublic enum HotSpotModetype HotSpotMode = Public Enum HotSpotMode- Inheritance
Fields
| Name | Value | Description |
|---|---|---|
| NotSet | 0 | The HotSpot uses the behavior set by the ImageMap control's HotSpotMode property. If the ImageMap control does not define the behavior, the HotSpot object navigates to a URL. |
| Navigate | 1 | The HotSpot navigates to a URL. |
| PostBack | 2 | The HotSpot generates a postback to the server. |
| Inactive | 3 | The HotSpot does not have any behavior. |
Examples
The following code example demonstrates how to use the HotSpotMode enumeration values to set the ImageMap.HotSpotMode property. The page contains an ImageMap control that contains two RectangleHotSpot objects. The ImageMap.HotSpotMode property is set to HotSpotMode.PostBack, which causes the page to post back to the server each time a user clicks one of the hot spot regions. The HotSpotMode property is not set on either of the RectangleHotSpot objects because they get their behavior from the ImageMap.HotSpotMode property. For this example to work correctly, you must supply your own image for the ImageUrl property and update the path to the image appropriately so that the application can locate it.
<%@ page language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
void VoteMap_Clicked(object sender, ImageMapEventArgs e)
{
// When a user clicks the "Yes" hot spot,
// display the hot spot's value.
if (e.PostBackValue == "Yes")
Message1.Text = "You selected " + e.PostBackValue + ".";
else if (e.PostBackValue == "No")
// When a user clicks the "No" hot spot,
// display the hot spot's value.
Message1.Text = "You selected " + e.PostBackValue + ".";
else
Message1.Text = "You did not click a valid hot spot region.";
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="head1" runat="server">
<title>ImageMap.HotSpotMode Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>ImageMap.HotSpotMode Example</h3>
<!--The RectangleHotSpot objects have the post back
behavior specified by the HotSpotMode
property on the ImageMap control.-->
<asp:imagemap id="Vote"
imageurl="Images/VoteImage.jpg"
alternatetext="Voting choices"
hotspotmode="PostBack"
onclick="VoteMap_Clicked"
runat="Server">
<asp:RectangleHotSpot
top="0"
left="0"
bottom="354"
right="250"
postbackvalue="Yes"
alternatetext="Vote yes">
</asp:RectangleHotSpot>
<asp:RectangleHotSpot
top="0"
left="251"
bottom="354"
right="500"
postbackvalue="No"
alternatetext="Vote no">
</asp:RectangleHotSpot>
</asp:imagemap>
<br />
<asp:label id="Message1"
runat="Server">
</asp:label>
</form>
</body>
</html>
<%@ page language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
Sub VoteMap_Clicked(ByVal sender As Object, ByVal e As ImageMapEventArgs)
' When a user clicks the "Yes" hot spot,
' display the hot spot's value.
If (e.PostBackValue = "Yes") Then
Message1.Text = "You selected " & e.PostBackValue & "."
' When a user clicks the "No" hot spot,
' display the hot spot's value.
ElseIf (e.PostBackValue = "No") Then
Message1.Text = "You selected " & e.PostBackValue & "."
Else
Message1.Text = "You did not click a valid hot spot region."
End If
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="head1" runat="server">
<title>ImageMap.HotSpotMode Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>ImageMap.HotSpotMode Example</h3>
<!--The RectangleHotSpot objects have the post back
behavior specified by the HotSpotMode
property on the ImageMap control.-->
<asp:imagemap id="Vote"
imageurl="Images/VoteImage.jpg"
alternatetext="Voting choices"
hotspotmode="PostBack"
onclick="VoteMap_Clicked"
runat="Server">
<asp:RectangleHotSpot
top="0"
left="0"
bottom="354"
right="250"
postbackvalue="Yes"
alternatetext="Vote yes">
</asp:RectangleHotSpot>
<asp:RectangleHotSpot
top="0"
left="251"
bottom="354"
right="500"
postbackvalue="No"
alternatetext="Vote no">
</asp:RectangleHotSpot>
</asp:imagemap>
<br />
<asp:label id="Message1"
runat="Server">
</asp:label>
</form>
</body>
</html>
Remarks
The HotSpotMode enumeration represents the behaviors that you can apply to a HotSpot object within an ImageMap control. The ImageMap.HotSpotMode and the HotSpot.HotSpotMode properties use these enumeration values to set the behavior of a HotSpot object when it is clicked. If both properties are set, the HotSpot.HotSpotMode property specified on each individual HotSpot object takes precedence over the ImageMap.HotSpotMode property on the control.
If you specify HotSpotMode.NotSet for the HotSpot.HotSpotMode property of an individual HotSpot object, the HotSpot gets its behavior from the containing ImageMap control's ImageMap.HotSpotMode property. In this scenario, if the ImageMap control's HotSpotMode property is either NotSet or no value is specified, the default behavior is to navigate to a URL.
Note
If an ImageMap control's behavior is not specified using either the ImageMap.HotSpotMode property or the HotSpot.HotSpotMode property on the HotSpot objects it contains, by default the behavior is HotSpotMode.Navigate. In addition, if the HotSpot.HotSpotMode properties on the HotSpot objects that an ImageMap control contains are set to HotSpotMode.NotSet and no value is specified for the ImageMap.HotSpotMode property, the default behavior is HotSpotMode.Navigate.
If you specify HotSpotMode.Navigate for either the ImageMap.HotSpotMode property or the HotSpot.HotSpotMode property, the page navigates to a URL when the HotSpot is clicked. Use the Image.NavigateUrl or the HotSpot.NavigateUrl property to specify the URL to navigate to.
If you specify HotSpotMode.PostBack for either the ImageMap.HotSpotMode property or the HotSpot.HotSpotMode property, the page generates a postback to the server when the HotSpot is clicked. Use the PostBackValue property to specify a name for the HotSpot object. This name will be passed in the ImageMapEventArgs event data when the postback event occurs. When a postback HotSpot is clicked, the Click event is raised. To programmatically control the actions performed when a postback HotSpot is clicked, provide an event handler for the Click event.
If you specify HotSpotMode.Inactive for the HotSpot.HotSpotMode property, the HotSpot object does not have any behavior when it is clicked. You can use this value to create an inactive hot spot within a larger active hot spot. This option is provided to allow you to create more complex hot spot zones within an ImageMap control.
To create an inactive area within an active hot spot, you must specify the inactive hot spot before the active one in the ImageMap control. For example, the following ImageMap defines an active ring by specifying an inactive circular hot spot within a larger active circular hot spot:
<asp:ImageMap ID="SaturnImage"
ImageUrl="~/saturn.PNG"
runat="server" OnClick="SaturnImage_Click">
<asp:CircleHotSpot AlternateText="planet" HotSpotMode=PostBack
PostBackValue="planet" Radius=40 X=100 Y=100 />
<asp:CircleHotSpot HotSpotMode=Inactive
Radius=60 X=100 Y=100 />
<asp:CircleHotSpot AlternateText="rings" HotSpotMode=PostBack
PostBackValue="rings" Radius=80 X=100 Y=100 />
</asp:ImageMap>
