Export (0) Print
Expand All

HotSpot Class

Implements the basic functionality common to all hot spot shapes.

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

[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public abstract class HotSpot : IStateManager

The HotSpot type exposes the following members.

  NameDescription
Protected methodHotSpotInitializes a new instance of the HotSpot class.
Top

  NameDescription
Public propertyAccessKeyGets or sets the access key that allows you to quickly navigate to the HotSpot region.
Public propertyAlternateTextGets 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.
Public propertyHotSpotModeGets or sets the behavior of a HotSpot object in an ImageMap control when the HotSpot is clicked.
Protected propertyIsTrackingViewStateGets a value indicating whether the HotSpot object is tracking its view-state changes.
Protected propertyMarkupNameWhen overridden in a derived class, gets the string representation for the HotSpot object's shape.
Public propertyNavigateUrlGets or sets the URL to navigate to when a HotSpot object is clicked.
Public propertyPostBackValueGets or sets the name of the HotSpot object to pass in the event data when the HotSpot is clicked.
Public propertyTabIndexGets or sets the tab index of the HotSpot region.
Public propertyTargetGets 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.
Protected propertyViewStateGets 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.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetCoordinatesWhen overridden in a derived class, returns a string that represents the coordinates of the HotSpot region.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodLoadViewStateRestores the HotSpot object's previously saved view state to the object.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSaveViewStateSaves the changes to the HotSpot object's view state since the time the page was posted back to the server.
Public methodToStringReturns the String representation of this instance of a HotSpot object. (Overrides Object.ToString().)
Protected methodTrackViewStateCauses 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.
Top

  NameDescription
Explicit interface implemetationPrivate propertyIStateManager.IsTrackingViewStateInfrastructure. Gets a value indicating whether the HotSpot object is tracking its view-state changes.
Explicit interface implemetationPrivate methodIStateManager.LoadViewStateInfrastructure. Restores the HotSpot object's previously saved view state to the object.
Explicit interface implemetationPrivate methodIStateManager.SaveViewStateInfrastructure. Saves the changes to the HotSpot object's view state since the last time the page was posted back to the server.
Explicit interface implemetationPrivate methodIStateManager.TrackViewStateInfrastructure. Instructs the HotSpot region to track changes to its view state.
Top

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

Supported in: 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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