HotSpot Class

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

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.

Implements the basic functionality common to all hot spot shapes.

public ref class HotSpot abstract : System::Web::UI::IStateManager

[System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))]
public abstract class HotSpot : System.Web.UI.IStateManager

[<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))>]
type HotSpot = class
    interface IStateManager

Public MustInherit Class HotSpot
Implements IStateManager

Inheritance: Object
HotSpot

Derived: System.Web.UI.WebControls.CircleHotSpot

System.Web.UI.WebControls.PolygonHotSpot

System.Web.UI.WebControls.RectangleHotSpot

Attributes: TypeConverterAttribute

Implements: IStateManager

Remarks

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 Implementers

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

Constructors

HotSpot()

Initializes a new instance of the HotSpot class.

Properties

AccessKey	Gets or sets the access key that allows you to quickly navigate to the HotSpot region.
AlternateText	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.
HotSpotMode	Gets or sets the behavior of a HotSpot object in an ImageMap control when the HotSpot is clicked.
IsTrackingViewState	Gets a value indicating whether the HotSpot object is tracking its view-state changes.
MarkupName	When overridden in a derived class, gets the string representation for the HotSpot object's shape.
NavigateUrl	Gets or sets the URL to navigate to when a HotSpot object is clicked.
PostBackValue	Gets or sets the name of the HotSpot object to pass in the event data when the HotSpot is clicked.
TabIndex	Gets or sets the tab index of the HotSpot region.
Target	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.
ViewState	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.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetCoordinates()	When overridden in a derived class, returns a string that represents the coordinates of the HotSpot region.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
LoadViewState(Object)	Restores the HotSpot object's previously saved view state to the object.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
SaveViewState()	Saves the changes to the HotSpot object's view state since the time the page was posted back to the server.
ToString()	Returns the String representation of this instance of a HotSpot object.
TrackViewState()	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 ViewState property.

Explicit Interface Implementations

IStateManager.IsTrackingViewState	Gets a value indicating whether the HotSpot object is tracking its view-state changes.
IStateManager.LoadViewState(Object)	Restores the HotSpot object's previously saved view state to the object.
IStateManager.SaveViewState()	Saves the changes to the HotSpot object's view state since the last time the page was posted back to the server.
IStateManager.TrackViewState()	Instructs the HotSpot region to track changes to its view state.

Applies to

Share via