linux-packaging-mono/mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls/HotSpotCollection.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="HotSpotCollection" FullName="System.Web.UI.WebControls.HotSpotCollection">
  <TypeSignature Language="C#" Value="public sealed class HotSpotCollection : System.Web.UI.StateManagedCollection" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Web.UI.StateManagedCollection</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>System.ComponentModel.Editor("System.Web.UI.Design.WebControls.HotSpotCollectionEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>The <see cref="T:System.Web.UI.WebControls.HotSpotCollection" /> class represents a collection that enables an <see cref="T:System.Web.UI.WebControls.ImageMap" /> control to maintain a list of the <see cref="T:System.Web.UI.WebControls.HotSpot" /> objects it contains.</para>
      <para>Use the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Add(System.Web.UI.WebControls.HotSpot)" /> method to add a specified <see cref="T:System.Web.UI.WebControls.HotSpot" /> object to the collection at the end of an ordinal index array. Use the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Insert(System.Int32,System.Web.UI.WebControls.HotSpot)" /> method to add a <see cref="T:System.Web.UI.WebControls.HotSpot" /> object to the collection at a specified index location. Use the <see cref="P:System.Web.UI.WebControls.HotSpotCollection.Item(System.Int32)" /> indexer to directly access a <see cref="T:System.Web.UI.WebControls.HotSpot" /> object in the collection at a specified index, using simple array notation.</para>
      <para>Use the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Remove(System.Web.UI.WebControls.HotSpot)" /> method to remove a <see cref="T:System.Web.UI.WebControls.HotSpot" /> object from the end of the collection. Use the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.RemoveAt(System.Int32)" /> method to remove a <see cref="T:System.Web.UI.WebControls.HotSpot" /> object from a specified index location.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Represents a collection of <see cref="T:System.Web.UI.WebControls.HotSpot" /> objects inside an <see cref="T:System.Web.UI.WebControls.ImageMap" /> control. This class cannot be inherited.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public HotSpotCollection ();" />
      <MemberType>Constructor</MemberType>
      <Parameters />
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>When overridden in a derived class, this constructor initializes a new instance of the <see cref="T:System.Web.UI.WebControls.HotSpotCollection" /> class.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.HotSpotCollection" /> class.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Add">
      <MemberSignature Language="C#" Value="public int Add (System.Web.UI.WebControls.HotSpot spot);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="spot" Type="System.Web.UI.WebControls.HotSpot" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Add(System.Web.UI.WebControls.HotSpot)" /> method adds the specified <see cref="T:System.Web.UI.WebControls.HotSpot" /> object to the end of the collection. To add a <see cref="T:System.Web.UI.WebControls.HotSpot" /> object to the collection at a specific index location, use the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Insert(System.Int32,System.Web.UI.WebControls.HotSpot)" /> method.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Appends a specified <see cref="T:System.Web.UI.WebControls.HotSpot" /> object to the end of the <see cref="T:System.Web.UI.WebControls.HotSpotCollection" /> collection.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The index at which the object was added to the collection.</para>
        </returns>
        <param name="spot">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.HotSpot" /> object to append to the collection. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="CreateKnownType">
      <MemberSignature Language="C#" Value="protected override object CreateKnownType (int idx);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="idx" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="idx">To be added.</param>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.WebControls.HotSpotCollection.CreateKnownType(System.Int32)" /> method creates an instance of a <see cref="T:System.Web.UI.WebControls.HotSpot" /> object according to the index of the type returned by the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.GetKnownTypes" /> method. The index values correspond to the types shown in the following table.</para>
          <list type="table">
            <listheader>
              <item>
                <term>
                  <para>Index</para>
                </term>
                <description>
                  <para>Parameter Type</para>
                </description>
              </item>
            </listheader>
            <item>
              <term>
                <para>0</para>
              </term>
              <description>
                <para>
                  <see cref="T:System.Web.UI.WebControls.CircleHotSpot" /> </para>
              </description>
            </item>
            <item>
              <term>
                <para>1</para>
              </term>
              <description>
                <para>
                  <see cref="T:System.Web.UI.WebControls.RectangleHotSpot" />
                </para>
              </description>
            </item>
            <item>
              <term>
                <para>2</para>
              </term>
              <description>
                <para>
                  <see cref="T:System.Web.UI.WebControls.PolygonHotSpot" /> </para>
              </description>
            </item>
          </list>
          <para>For example, if you specify 0 for the <paramref name="index" /> parameter, the method returns a <see cref="T:System.Web.UI.WebControls.CircleHotSpot" /> object. If you specify 1 for the <paramref name="index" /> parameter, the method returns a <see cref="T:System.Web.UI.WebControls.RectangleHotSpot" /> object. </para>
          <para>The <see cref="M:System.Web.UI.WebControls.HotSpotCollection.GetKnownTypes" /> method returns an <see cref="T:System.Collections.ArrayList" /> object containing the known types of controls derived from the <see cref="T:System.Web.UI.WebControls.HotSpot" /> class.</para>
          <block subset="none" type="note">
            <para>This method is used only by control developers.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Creates a default instance of a type derived from the <see cref="T:System.Web.UI.WebControls.HotSpot" /> class.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>An object of a specified type derived from the <see cref="T:System.Web.UI.WebControls.HotSpot" /> class.</para>
        </returns>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="GetKnownTypes">
      <MemberSignature Language="C#" Value="protected override Type[] GetKnownTypes ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Type[]</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.WebControls.HotSpotCollection.GetKnownTypes" /> method returns an array of <see cref="T:System.Web.UI.WebControls.HotSpot" /> object-derived types that the collection can contain. The array contains the <see cref="T:System.Web.UI.WebControls.CircleHotSpot" /> object, the <see cref="T:System.Web.UI.WebControls.RectangleHotSpot" /> object, and the <see cref="T:System.Web.UI.WebControls.PolygonHotSpot" /> object.</para>
          <para>Use the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.CreateKnownType(System.Int32)" /> method to return an instance of one of the types contained in the array. If you specify 0 for the method's <paramref name="index" /> parameter, the method returns a <see cref="T:System.Web.UI.WebControls.CircleHotSpot" /> object. If you specify 1 for the <paramref name="index" /> parameter, the method returns a <see cref="T:System.Web.UI.WebControls.RectangleHotSpot" /> object. If you specify 2 for the <paramref name="index" /> parameter, the method returns a <see cref="T:System.Web.UI.WebControls.PolygonHotSpot" /> object.</para>
          <block subset="none" type="note">
            <para>This method is used only by control developers.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Creates an array of the <see cref="T:System.Web.UI.WebControls.HotSpot" /> object-derived types that a <see cref="T:System.Web.UI.WebControls.HotSpotCollection" /> collection can contain. </para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>An array of <see cref="T:System.Web.UI.WebControls.HotSpot" /> object-derived types that a <see cref="T:System.Web.UI.WebControls.HotSpotCollection" /> collection can contain.</para>
        </returns>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Insert">
      <MemberSignature Language="C#" Value="public void Insert (int idx, System.Web.UI.WebControls.HotSpot spot);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="idx" Type="System.Int32" />
        <Parameter Name="spot" Type="System.Web.UI.WebControls.HotSpot" />
      </Parameters>
      <Docs>
        <param name="idx">To be added.</param>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Insert(System.Int32,System.Web.UI.WebControls.HotSpot)" /> method adds the specified <see cref="T:System.Web.UI.WebControls.HotSpot" /> object to the collection at the specified index location. To append a <see cref="T:System.Web.UI.WebControls.HotSpot" /> object to the end of the collection, use the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Add(System.Web.UI.WebControls.HotSpot)" /> method.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Inserts a specified <see cref="T:System.Web.UI.WebControls.HotSpot" /> object into the <see cref="T:System.Web.UI.WebControls.HotSpotCollection" /> collection at the specified index location.</para>
        </summary>
        <param name="spot">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.HotSpot" /> object to add to the collection. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Item">
      <MemberSignature Language="C#" Value="public System.Web.UI.WebControls.HotSpot this[int idx] { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Web.UI.WebControls.HotSpot</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="idx" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="idx">To be added.</param>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="OnValidate">
      <MemberSignature Language="C#" Value="protected override void OnValidate (object o);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="o" Type="System.Object" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This method checks the specified <see cref="T:System.Object" /> to determine whether it is a valid type derived from the <see cref="T:System.Web.UI.WebControls.HotSpot" /> class. Only an object of type <see cref="T:System.Web.UI.WebControls.CircleHotSpot" />, <see cref="T:System.Web.UI.WebControls.RectangleHotSpot" />, or <see cref="T:System.Web.UI.WebControls.PolygonHotSpot" /> is considered a valid type. </para>
          <block subset="none" type="note">
            <para>This method is used only by control developers.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Checks the specified object to determine whether it is a valid type derived from the <see cref="T:System.Web.UI.WebControls.HotSpot" /> class.</para>
        </summary>
        <param name="o">
          <attribution license="cc4" from="Microsoft" modified="false" />The object to validate. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Remove">
      <MemberSignature Language="C#" Value="public void Remove (System.Web.UI.WebControls.HotSpot spot);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="spot" Type="System.Web.UI.WebControls.HotSpot" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Remove(System.Web.UI.WebControls.HotSpot)" /> method removes the specified <see cref="T:System.Web.UI.WebControls.HotSpot" /> object from the collection. To remove a <see cref="T:System.Web.UI.WebControls.HotSpot" /> object from the collection at a specified index location, use the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.RemoveAt(System.Int32)" /> method.</para>
          <para>To add new <see cref="T:System.Web.UI.WebControls.HotSpot" /> objects to the collection, use the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Add(System.Web.UI.WebControls.HotSpot)" /> or the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Insert(System.Int32,System.Web.UI.WebControls.HotSpot)" /> method.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Removes the specified <see cref="T:System.Web.UI.WebControls.HotSpot" /> object from the <see cref="T:System.Web.UI.WebControls.HotSpotCollection" /> collection.</para>
        </summary>
        <param name="spot">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.HotSpot" /> object to remove from the collection. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="RemoveAt">
      <MemberSignature Language="C#" Value="public void RemoveAt (int idx);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="idx" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="idx">To be added.</param>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.WebControls.HotSpotCollection.RemoveAt(System.Int32)" /> method removes the <see cref="T:System.Web.UI.WebControls.HotSpot" /> object at the specified index location from the collection. To remove a specific <see cref="T:System.Web.UI.WebControls.HotSpot" /> object from the collection by name, use the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Remove(System.Web.UI.WebControls.HotSpot)" /> method.</para>
          <para>To add new <see cref="T:System.Web.UI.WebControls.HotSpot" /> objects to the collection, use the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Add(System.Web.UI.WebControls.HotSpot)" /> or the <see cref="M:System.Web.UI.WebControls.HotSpotCollection.Insert(System.Int32,System.Web.UI.WebControls.HotSpot)" /> method.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Removes the <see cref="T:System.Web.UI.WebControls.HotSpot" /> object at the specified index location from the collection.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="SetDirtyObject">
      <MemberSignature Language="C#" Value="protected override void SetDirtyObject (object o);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="o" Type="System.Object" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This method marks the specified <see cref="T:System.Web.UI.WebControls.HotSpot" /> object as changed since it was last loaded or saved from view state. This allows the object to save its entire view state.</para>
          <block subset="none" type="note">
            <para>This method is used only by control developers.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Marks the specified <see cref="T:System.Web.UI.WebControls.HotSpot" /> object as changed since it was last loaded or saves from view state.</para>
        </summary>
        <param name="o">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.HotSpot" /> object to mark as changed since it was last loaded or saved from view state.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>