HotSpotCollection Class
TOC
Collapse the table of content
Expand the table of content

HotSpotCollection Class

 

Represents a collection of HotSpot objects inside 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.StateManagedCollection
    System.Web.UI.WebControls.HotSpotCollection

public sealed class HotSpotCollection : StateManagedCollection

NameDescription
System_CAPS_pubmethodHotSpotCollection()

Initializes a new instance of the HotSpotCollection class.

NameDescription
System_CAPS_pubpropertyCount

Gets the number of elements contained in the StateManagedCollection collection.(Inherited from StateManagedCollection.)

System_CAPS_pubpropertyItem[Int32]

Gets a reference to the HotSpot object at the specified index in the HotSpotCollection collection.

NameDescription
System_CAPS_pubmethodAdd(HotSpot)

Appends a specified HotSpot object to the end of the HotSpotCollection collection.

System_CAPS_pubmethodClear()

Removes all items from the StateManagedCollection collection.(Inherited from StateManagedCollection.)

System_CAPS_pubmethodCopyTo(Array, Int32)

Copies the elements of the StateManagedCollection collection to an array, starting at a particular array index.(Inherited from StateManagedCollection.)

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_pubmethodGetEnumerator()

Returns an iterator that iterates through the StateManagedCollection collection.(Inherited from StateManagedCollection.)

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_pubmethodInsert(Int32, HotSpot)

Inserts a specified HotSpot object into the HotSpotCollection collection at the specified index location.

System_CAPS_pubmethodRemove(HotSpot)

Removes the specified HotSpot object from the HotSpotCollection collection.

System_CAPS_pubmethodRemoveAt(Int32)

Removes the HotSpot object at the specified index location from the collection.

System_CAPS_pubmethodSetDirty()

Forces the entire StateManagedCollection collection to be serialized into view state. (Inherited from StateManagedCollection.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable.GetEnumerator()

This API supports the product infrastructure and is not intended to be used directly from your code. Returns an iterator that iterates through the StateManagedCollection collection.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Add(Object)

Adds an item to the StateManagedCollection collection.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Clear()

This API supports the product infrastructure and is not intended to be used directly from your code. Removes all items from the StateManagedCollection collection.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Contains(Object)

Determines whether the StateManagedCollection collection contains a specific value.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.IndexOf(Object)

Determines the index of a specified item in the StateManagedCollection collection.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Insert(Int32, Object)

Inserts an item into the StateManagedCollection collection at the specified index.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Remove(Object)

Removes the first occurrence of the specified object from the StateManagedCollection collection.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.RemoveAt(Int32)

Removes the IStateManager element at the specified index.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.LoadViewState(Object)

Restores the previously saved view state of the StateManagedCollection collection and the IStateManager items it contains.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.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.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.Count

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the number of elements contained in the StateManagedCollection collection.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.IsSynchronized

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether the StateManagedCollection collection is synchronized (thread safe). This method returns false in all cases.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.SyncRoot

This API supports the product infrastructure and is not intended to be used directly from your code. Gets an object that can be used to synchronize access to the StateManagedCollection collection. This method returns null in all cases.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsFixedSize

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether the StateManagedCollection collection has a fixed size. This method returns false in all cases.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsReadOnly

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether the StateManagedCollection collection is read-only.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.Item[Int32]

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the IStateManager element at the specified index.(Inherited from StateManagedCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIStateManager.IsTrackingViewState

Gets a value indicating whether the StateManagedCollection collection is saving changes to its view state.(Inherited from StateManagedCollection.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

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.

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.

<%@ 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>

.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:
© 2016 Microsoft