CircleHotSpot Class

 

Defines a circular hot spot region in an ImageMap control. This class cannot be inherited.

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

System.Object
  System.Web.UI.WebControls.HotSpot
    System.Web.UI.WebControls.CircleHotSpot

public sealed class CircleHotSpot : HotSpot

NameDescription
System_CAPS_pubmethodCircleHotSpot()

Initializes a new instance of the CircleHotSpot class.

NameDescription
System_CAPS_pubpropertyAccessKey

Gets or sets the access key that allows you to quickly navigate to the HotSpot region.(Inherited from HotSpot.)

System_CAPS_pubpropertyAlternateText

Gets or sets the alternate text to display for a HotSpot object in an ImageMap control when the image is unavailable or renders to a browser that does not support images.(Inherited from HotSpot.)

System_CAPS_pubpropertyHotSpotMode

Gets or sets the behavior of a HotSpot object in an ImageMap control when the HotSpot is clicked.(Inherited from HotSpot.)

System_CAPS_protpropertyMarkupName

When overridden in a derived class, gets the string representation for the HotSpot object's shape.(Inherited from HotSpot.)

System_CAPS_pubpropertyNavigateUrl

Gets or sets the URL to navigate to when a HotSpot object is clicked.(Inherited from HotSpot.)

System_CAPS_pubpropertyPostBackValue

Gets or sets the name of the HotSpot object to pass in the event data when the HotSpot is clicked.(Inherited from HotSpot.)

System_CAPS_pubpropertyRadius

Gets or sets the distance from the center to the edge of the circular region defined by this CircleHotSpot object.

System_CAPS_pubpropertyTabIndex

Gets or sets the tab index of the HotSpot region.(Inherited from HotSpot.)

System_CAPS_pubpropertyTarget

Gets or sets the target window or frame in which to display the Web page content linked to when a HotSpot object that navigates to a URL is clicked.(Inherited from HotSpot.)

System_CAPS_pubpropertyX

Gets or sets the x-coordinate of the center of the circular region defined by this CircleHotSpot object.

System_CAPS_pubpropertyY

Gets or sets the y-coordinate of the center of the circular region defined by this CircleHotSpot object.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetCoordinates()

Returns a string that represents the x- and y-coordinates of a CircleHotSpot object's center and the length of its radius.(Overrides HotSpot.GetCoordinates().)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns the String representation of this instance of a HotSpot object.(Inherited from HotSpot.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.LoadViewState(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Restores the HotSpot object's previously saved view state to the object.(Inherited from HotSpot.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.SaveViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Saves the changes to the HotSpot object's view state since the last time the page was posted back to the server.(Inherited from HotSpot.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.TrackViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Instructs the HotSpot region to track changes to its view state.(Inherited from HotSpot.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIStateManager.IsTrackingViewState

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether the HotSpot object is tracking its view-state changes. (Inherited from HotSpot.)

This class defines a circle-shaped hot spot region in an ImageMap control. To define the region of the CircleHotSpot object, set the X property to the value that represents the x-coordinate of the center of the circular region. Set the Y property to the value that represents the y-coordinate of the center of the circular region. Set the Radius property to the distance from the center of the circle to the edge.

When a CircleHotSpot control is clicked, the page either navigates to a URL, generates a post back to the server, or does nothing. The HotSpotMode property specifies this behavior. To navigate to a URL, set the HotSpotMode property to HotSpotMode.Navigate, and use the NavigateUrl property to specify the URL to navigate to. To post back to the server, set the HotSpotMode property to HotSpotMode.PostBack, and use the PostBackValue property to specify a name for the CircleHotSpot object. This name will be passed in the ImageMapEventArgs event data when the CircleHotSpot is clicked. If you want the CircleHotSpot object to have no behavior, set the HotSpotMode property to HotSpotMode.Inactive.

The following code example demonstrates how to declaratively create an ImageMap control that contains two CircleHotSpot objects. The HotSpotMode property is set to HotSpotMode.Navigate, which causes the page to navigate to the specified URL each time a user clicks one of the hot spot regions. 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">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="head1" runat="server">
  <title>ImageMap Class Navigate Example</title>
</head>
  <body>
    <form id="form1" runat="server">

      <h3>ImageMap Class Navigate Example</h3>

      <h4>Shopping Choices:</h4>

      <asp:imagemap id="Shop"           
        imageurl="Images/ShopChoice.jpg"
        width="150" 
        height="360"
        alternatetext="Shopping choices" 
        runat="Server">    

        <asp:circlehotspot
          navigateurl="http://www.tailspintoys.com"
          x="75"
          y="290"
          radius="75"
          hotspotmode="Navigate"
          alternatetext="Shop for toys">           
        </asp:circlehotspot> 

        <asp:circlehotspot
          navigateurl="http://www.cohowinery.com"
          x="75"
          y="120"
          radius="75"
          hotspotmode="Navigate"
          alternatetext="Shop for wine">
        </asp:circlehotspot>     

      </asp:imagemap>                 

    </form>      
  </body>
</html>

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: