HotSpotCollection Class (System.Web.UI.WebControls)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
HotSpotCollection Class

Represents a collection of HotSpot objects inside an ImageMap control. This class cannot be inherited.

Inheritance Hierarchy
System.Object
  System.Web.UI.StateManagedCollection
    System.Web.UI.WebControls.HotSpotCollection

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
Syntax
Visual Basic
Public NotInheritable Class HotSpotCollection _
	Inherits StateManagedCollection
C#
public sealed class HotSpotCollection : StateManagedCollection
Visual C++
public ref class HotSpotCollection sealed : public StateManagedCollection
F#
[<Sealed>]
type HotSpotCollection =  
    class
        inherit StateManagedCollection
    end

The HotSpotCollection type exposes the following members.

Constructors
  Name Description
Public method HotSpotCollection Initializes a new instance of the HotSpotCollection class.
Top
Properties
  Name Description
Public property Count Gets the number of elements contained in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public property Item Gets a reference to the HotSpot object at the specified index in the HotSpotCollection collection.
Top
Methods
  Name Description
Public method Add Appends a specified HotSpot object to the end of the HotSpotCollection collection.
Public method Clear Removes all items from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public method CopyTo Copies the elements of the StateManagedCollection collection to an array, starting at a particular array index. (Inherited from StateManagedCollection.)
Protected method CreateKnownType When overridden in a derived class, creates an instance of a class that implements IStateManager. The type of object created is based on the specified member of the collection returned by the GetKnownTypes method. (Inherited from StateManagedCollection.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetKnownTypes When overridden in a derived class, gets an array of IStateManager types that the StateManagedCollection collection can contain. (Inherited from StateManagedCollection.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Insert Inserts a specified HotSpot object into the HotSpotCollection collection at the specified index location.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnClear When overridden in a derived class, performs additional work before the Clear method removes all items from the collection. (Inherited from StateManagedCollection.)
Protected method OnClearComplete When overridden in a derived class, performs additional work after the Clear method finishes removing all items from the collection. (Inherited from StateManagedCollection.)
Protected method OnInsert When overridden in a derived class, performs additional work before the Insert(Int32, Object) or Add(Object) method adds an item to the collection. (Inherited from StateManagedCollection.)
Protected method OnInsertComplete When overridden in a derived class, performs additional work after the Insert(Int32, Object) or Add(Object) method adds an item to the collection. (Inherited from StateManagedCollection.)
Protected method OnRemove When overridden in a derived class, performs additional work before the Remove(Object) or RemoveAt(Int32) method removes the specified item from the collection. (Inherited from StateManagedCollection.)
Protected method OnRemoveComplete When overridden in a derived class, performs additional work after the Remove(Object) or RemoveAt(Int32) method removes the specified item from the collection. (Inherited from StateManagedCollection.)
Protected method OnValidate When overridden in a derived class, validates an element of the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public method Remove Removes the specified HotSpot object from the HotSpotCollection collection.
Public method RemoveAt Removes the HotSpot object at the specified index location from the collection.
Public method SetDirty Forces the entire StateManagedCollection collection to be serialized into view state. (Inherited from StateManagedCollection.)
Protected method SetDirtyObject When overridden in a derived class, instructs an object contained by the collection to record its entire state to view state, rather than recording only change information. (Inherited from StateManagedCollection.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  Name Description
Explicit interface implemetation Private property ICollection.Count Infrastructure. Gets the number of elements contained in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property ICollection.IsSynchronized Infrastructure. Gets a value indicating whether the StateManagedCollection collection is synchronized (thread safe). This method returns false in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property ICollection.SyncRoot Infrastructure. Gets an object that can be used to synchronize access to the StateManagedCollection collection. This method returns null in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IEnumerable.GetEnumerator Infrastructure. Returns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Add Adds an item to the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Clear Infrastructure. Removes all items from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Contains Determines whether the StateManagedCollection collection contains a specific value. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.IndexOf Determines the index of a specified item in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Insert Inserts an item into the StateManagedCollection collection at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IList.IsFixedSize Infrastructure. Gets a value indicating whether the StateManagedCollection collection has a fixed size. This method returns false in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IList.IsReadOnly Infrastructure. Gets a value indicating whether the StateManagedCollection collection is read-only. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IList.Item Infrastructure. Gets the IStateManager element at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Remove Removes the first occurrence of the specified object from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.RemoveAt Removes the IStateManager element at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IStateManager.IsTrackingViewState Gets a value indicating whether the StateManagedCollection collection is saving changes to its view state. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IStateManager.LoadViewState Restores the previously saved view state of the StateManagedCollection collection and the IStateManager items it contains. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IStateManager.SaveViewState Saves the changes to the StateManagedCollection collection and each IStateManager object it contains since the time the page was posted back to the server. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IStateManager.TrackViewState Causes the StateManagedCollection collection and each of the IStateManager objects it contains to track changes to their view state so they can be persisted across requests for the same page. (Inherited from StateManagedCollection.)
Top
Remarks

The HotSpotCollection class represents a collection that enables an ImageMap control to maintain a list of the HotSpot objects it contains.

Use the Add method to add a specified HotSpot object to the collection at the end of an ordinal index array. Use the Insert method to add a HotSpot object to the collection at a specified index location. Use the Item indexer to directly access a HotSpot object in the collection at a specified index, using simple array notation.

Use the Remove method to remove a HotSpot object from the end of the collection. Use the RemoveAt method to remove a HotSpot object from a specified index location.

Examples

The following code example demonstrates how to programmatically create an ImageMap control and add two CircleHotSpot objects to it. The HotSpots property is used to access the HotSpotCollection collection for the ImageMap control and add the CircleHotSpot objects to it. 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.

Visual Basic

<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)

    ' Programmatically create an ImageMap control.
    Dim Shop As New ImageMap
    Shop.ImageUrl = "Images/ShopChoice.jpg"
    Shop.AlternateText = "Shopping choices"

    ' Add the ImageMap control to the 
    ' Controls collection of the page.
    Page.Controls.Add(Shop)

    ' Programmatically create a CircleHotSpot object.
    Dim Circle1 As New CircleHotSpot
    Circle1.HotSpotMode = HotSpotMode.Navigate
    Circle1.NavigateUrl = "http://www.tailspintoys.com"
    Circle1.X = 145
    Circle1.Y = 120
    Circle1.Radius = 75
    Circle1.AlternateText = "Shop for toys"

    ' Add Circle1 to the ImageMap's HotSpotCollection.    
    Shop.HotSpots.Add(Circle1)

    ' Programmatically create a second CircleHotSpot object.
    Dim Circle2 As New CircleHotSpot
    Circle2.HotSpotMode = HotSpotMode.Navigate
    Circle2.NavigateUrl = "http://www.cohowinery.com"
    Circle2.X = 145
    Circle2.Y = 290
    Circle2.Radius = 75
    Circle2.AlternateText = "Shop for wine"


    ' Add Circle2 to the ImageMap's HotSpotCollection.    
    Shop.HotSpots.Add(Circle2)

  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="head1" runat="server">
  <title>ImageMap Class VB Constructor Example</title>
</head>
  <body>
    <form id="form1" runat="server">

      <h3>ImageMap Class VB Constructor Example</h3>

      <h4>Shopping Choices:</h4>

    </form>      
  </body>
</html>
C#

<%@ page language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
  void Page_Load (Object sender, EventArgs e)
  {
    // Programmatically create an ImageMap control.
    ImageMap Shop = new ImageMap();

    // Set properties on the ImageMap control.
    Shop.ImageUrl = "Images/ShopChoice.jpg";
    Shop.AlternateText = "Shopping choices";

    // Add the ImageMap control to the 
    // Controls collection of the page.
    Page.Controls.Add(Shop);

    // Programmatically create a CircleHotSpot object.
    CircleHotSpot Circle1 = new CircleHotSpot();
    Circle1.HotSpotMode = HotSpotMode.Navigate;
    Circle1.NavigateUrl = "http://www.tailspintoys.com";
    Circle1.X = 145;
    Circle1.Y = 120;
    Circle1.Radius = 75;
    Circle1.AlternateText = "Shop for toys";

    // Add Circle1 to the ImageMap's HotSpotCollection.    
    Shop.HotSpots.Add(Circle1);

    // Programmatically create a second CircleHotSpot object.
    CircleHotSpot Circle2 = new CircleHotSpot();
    Circle2.HotSpotMode = HotSpotMode.Navigate;
    Circle2.NavigateUrl = "http://www.cohowinery.com";
    Circle2.X = 145;
    Circle2.Y = 290;
    Circle2.Radius = 75;
    Circle2.AlternateText = "Shop for wine";

    // Add Circle2 to the ImageMap's HotSpotCollection.    
    Shop.HotSpots.Add(Circle2);
  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="head1" runat="server">
  <title>ImageMap Class C# Constructor Example</title>
</head>
  <body>
    <form id="form1" runat="server">

      <h3>ImageMap Class C# Constructor Example</h3>

      <h4>Shopping Choices:</h4>

    </form>      
  </body>
</html>
Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System.Web.UI.WebControls Namespace
ImageMap
HotSpot

Other Resources

ImageMap Web Server Control Overview