HotSpot Class

 

Implements the basic functionality common to all hot spot shapes.

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


[<AbstractClass>]
[<TypeConverterAttribute(typeof(ExpandableObjectConverter))>]
type HotSpot = 
    class
        interface IStateManager
    end

NameDescription
System_CAPS_protmethodHotSpot()

Initializes a new instance of the HotSpot class.

NameDescription
System_CAPS_pubpropertyAccessKey

Gets or sets the access key that allows you to quickly navigate to the HotSpot region.

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.

System_CAPS_pubpropertyHotSpotMode

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

System_CAPS_protpropertyIsTrackingViewState

Gets a value indicating whether the HotSpot object is tracking its view-state changes.

System_CAPS_protpropertyMarkupName

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

System_CAPS_pubpropertyNavigateUrl

Gets or sets the URL to navigate to when a HotSpot object is clicked.

System_CAPS_pubpropertyPostBackValue

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

System_CAPS_pubpropertyTabIndex

Gets or sets the tab index of the HotSpot region.

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.

System_CAPS_protpropertyViewState

Gets a dictionary of state information that allows you to save and restore the view state of a HotSpot object across multiple requests for the same page.

NameDescription
System_CAPS_pubmethodEquals(Object)

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

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetCoordinates()

When overridden in a derived class, returns a string that represents the coordinates of the HotSpot region.

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_protmethodLoadViewState(Object)

Restores the HotSpot object's previously saved view state to the object.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodSaveViewState()

Saves the changes to the HotSpot object's view state since the time the page was posted back to the server.

System_CAPS_pubmethodToString()

Returns the String representation of this instance of a HotSpot object.(Overrides Object.ToString().)

System_CAPS_protmethodTrackViewState()

Causes the HotSpot object to track changes to its view state so they can be stored in the object's StateBag object. This object is accessible through the Control.ViewState property.

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.

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.

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.

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.

You cannot directly create instances of the abstract HotSpot class. Instead, this class is inherited by the CircleHotSpot, RectangleHotSpot, and PolygonHotSpot classes to provide the common basic functionality for a hot spot. You must derive from the HotSpot class to create a custom hot spot class that represents a unique shape that you define. However, you can define most shapes using the CircleHotSpot, RectangleHotSpot, and PolygonHotSpot classes.

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

Alternately, you can use the HotSpotMode property on the containing ImageMap control to specify a HotSpot object's behavior. For more information, see HotSpotMode.

Notes to Inheritors:

When you inherit from HotSpot, you must override the following members: GetCoordinates and MarkupName.

.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: