System.Web.UI.WebControls.HotSpotMode Enumeration

Specifies the behaviors of a System.Web.UI.WebControls.HotSpot object in an System.Web.UI.WebControls.ImageMap control when the System.Web.UI.WebControls.HotSpot is clicked.


public enum HotSpotMode


The System.Web.UI.WebControls.HotSpotMode enumeration represents the behaviors that you can apply to a System.Web.UI.WebControls.HotSpot object within an System.Web.UI.WebControls.ImageMap control. The ImageMap.HotSpotMode and the HotSpot.HotSpotMode properties use these enumeration values to set the behavior of a System.Web.UI.WebControls.HotSpot object when it is clicked. If both properties are set, the HotSpot.HotSpotMode property specified on each individual System.Web.UI.WebControls.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 System.Web.UI.WebControls.HotSpot object, the System.Web.UI.WebControls.HotSpot gets its behavior from the containing System.Web.UI.WebControls.ImageMap control's ImageMap.HotSpotMode property. In this scenario, if the System.Web.UI.WebControls.ImageMap control's ImageMap.HotSpotMode property is either NotSet or no value is specified, the default behavior is to navigate to a URL.


If an System.Web.UI.WebControls.ImageMap control's behavior is not specified using either the ImageMap.HotSpotMode property or the HotSpot.HotSpotMode property on the System.Web.UI.WebControls.HotSpot objects it contains, by default the behavior is HotSpotMode.Navigate. In addition, if the HotSpot.HotSpotMode properties on the System.Web.UI.WebControls.HotSpot objects that an System.Web.UI.WebControls.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 System.Web.UI.WebControls.HotSpot is clicked. Use the System.Web.UI.MobileControls.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 System.Web.UI.WebControls.HotSpot is clicked. Use the HotSpot.PostBackValue property to specify a name for the System.Web.UI.WebControls.HotSpot object. This name will be passed in the System.Web.UI.WebControls.ImageMapEventArgs event data when the postback event occurs. When a postback System.Web.UI.WebControls.HotSpot is clicked, the ImageMap.Click event is raised. To programmatically control the actions performed when a postback System.Web.UI.WebControls.HotSpot is clicked, provide an event handler for the ImageMap.Click event.

If you specify HotSpotMode.Inactive for the HotSpot.HotSpotMode property, the System.Web.UI.WebControls.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 System.Web.UI.WebControls.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 System.Web.UI.WebControls.ImageMap control. For example, the following System.Web.UI.WebControls.ImageMap defines an active ring by specifying an inactive circular hot spot within a larger active circular hot spot:


    <asp:ImageMap ID="SaturnImage" 
           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 />


Member NameDescription

The System.Web.UI.WebControls.HotSpot does not have any behavior.


The System.Web.UI.WebControls.HotSpot navigates to a URL.


The System.Web.UI.WebControls.HotSpot uses the behavior set by the System.Web.UI.WebControls.ImageMap control's ImageMap.HotSpotMode property. If the System.Web.UI.WebControls.ImageMap control does not define the behavior, the System.Web.UI.WebControls.HotSpot object navigates to a URL.


The System.Web.UI.WebControls.HotSpot generates a postback to the server.


Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
Assembly Versions:
Since: .NET 2.0