HotSpotCollectionEditor.xml

<Type Name="HotSpotCollectionEditor" FullName="System.Web.UI.Design.WebControls.HotSpotCollectionEditor">
  <TypeSignature Language="C#" Value="public class HotSpotCollectionEditor : System.ComponentModel.Design.CollectionEditor" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit HotSpotCollectionEditor extends System.ComponentModel.Design.CollectionEditor" />
  <TypeSignature Language="DocId" Value="T:System.Web.UI.Design.WebControls.HotSpotCollectionEditor" />
  <TypeSignature Language="VB.NET" Value="Public Class HotSpotCollectionEditor&#xA;Inherits CollectionEditor" />
  <TypeSignature Language="F#" Value="type HotSpotCollectionEditor = class&#xA;    inherit CollectionEditor" />
  <TypeSignature Language="C++ CLI" Value="public ref class HotSpotCollectionEditor : System::ComponentModel::Design::CollectionEditor" />
  <AssemblyInfo>
    <AssemblyName>System.Design</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ComponentModel.Design.CollectionEditor</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Provides a component editor for <see cref="T:System.Web.UI.WebControls.HotSpotCollection" /> objects in an <see cref="T:System.Web.UI.WebControls.ImageMap" /> or a similar control.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Web.UI.Design.WebControls.HotSpotCollectionEditor> class provides a user interface for editing the <xref:System.Web.UI.WebControls.HotSpot> elements of the <xref:System.Web.UI.WebControls.HotSpotCollection> object that is embedded in an <xref:System.Web.UI.WebControls.ImageMap> or a similar control.  
  
 The <xref:System.Web.UI.Design.WebControls.HotSpotCollectionEditor> is invoked by selecting the ellipsis button (**…**) on the **HotSpots** property in the visual designer's **Properties** grid.  
  
 The <xref:System.Web.UI.Design.WebControls.HotSpotCollectionEditor.CanSelectMultipleInstances%2A> method always returns `false` to indicate that only one object can be selected at a time in the editor. The <xref:System.Web.UI.Design.WebControls.HotSpotCollectionEditor.CreateNewItemTypes%2A> method returns an array of types that the editor can create. The <xref:System.Web.UI.Design.WebControls.HotSpotCollectionEditor.HelpTopic%2A> property returns the name of the Help topic that the editor displays.  
  
 ]]></format>
    </remarks>
    <altmember cref="T:System.Web.UI.WebControls.HotSpot" />
    <altmember cref="T:System.Web.UI.WebControls.HotSpotCollection" />
    <altmember cref="T:System.ComponentModel.Design.CollectionEditor" />
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public HotSpotCollectionEditor (Type type);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Type type) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.HotSpotCollectionEditor.#ctor(System.Type)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (type As Type)" />
      <MemberSignature Language="F#" Value="new System.Web.UI.Design.WebControls.HotSpotCollectionEditor : Type -&gt; System.Web.UI.Design.WebControls.HotSpotCollectionEditor" Usage="new System.Web.UI.Design.WebControls.HotSpotCollectionEditor type" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; HotSpotCollectionEditor(Type ^ type);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters>
        <Parameter Name="type" Type="System.Type" />
      </Parameters>
      <Docs>
        <param name="type">The type of the collection to edit.</param>
        <summary>Initializes a new instance of the <see cref="T:System.Web.UI.Design.WebControls.HotSpotCollectionEditor" /> class.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The .NET Framework internally constructs a new instance of the <xref:System.Web.UI.Design.WebControls.HotSpotCollectionEditor> class when you select the ellipsis button (**…**) on the **HotSpots** property in the visual designer's **Properties** grid, when designing an <xref:System.Web.UI.WebControls.ImageMap> control or other control that encapsulates a <xref:System.Web.UI.WebControls.HotSpotCollection> object.  
  
 ]]></format>
        </remarks>
        <altmember cref="T:System.Web.UI.WebControls.HotSpotCollection" />
        <altmember cref="T:System.ComponentModel.Design.CollectionEditor" />
        <altmember cref="T:System.Web.UI.WebControls.ImageMap" />
      </Docs>
    </Member>
    <Member MemberName="CanSelectMultipleInstances">
      <MemberSignature Language="C#" Value="protected override bool CanSelectMultipleInstances ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance bool CanSelectMultipleInstances() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.HotSpotCollectionEditor.CanSelectMultipleInstances" />
      <MemberSignature Language="VB.NET" Value="Protected Overrides Function CanSelectMultipleInstances () As Boolean" />
      <MemberSignature Language="F#" Value="override this.CanSelectMultipleInstances : unit -&gt; bool" Usage="hotSpotCollectionEditor.CanSelectMultipleInstances " />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; override bool CanSelectMultipleInstances();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets a value indicating whether multiple <see cref="T:System.Web.UI.WebControls.HotSpot" /> collection elements can be selected at one time.</summary>
        <returns>Always <see langword="false" />.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Web.UI.Design.WebControls.HotSpotCollectionEditor.CanSelectMultipleInstances%2A> method always returns `false`; thus, only one <xref:System.Web.UI.WebControls.HotSpot> object can be selected at a time in the <xref:System.Web.UI.Design.WebControls.HotSpotCollectionEditor> object.  
  
 ]]></format>
        </remarks>
        <altmember cref="T:System.Web.UI.WebControls.HotSpot" />
        <altmember cref="T:System.Web.UI.WebControls.HotSpotCollection" />
        <altmember cref="M:System.ComponentModel.Design.CollectionEditor.CanSelectMultipleInstances" />
        <altmember cref="T:System.ComponentModel.Design.CollectionEditor" />
      </Docs>
    </Member>
    <Member MemberName="CreateNewItemTypes">
      <MemberSignature Language="C#" Value="protected override Type[] CreateNewItemTypes ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.Type[] CreateNewItemTypes() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.HotSpotCollectionEditor.CreateNewItemTypes" />
      <MemberSignature Language="VB.NET" Value="Protected Overrides Function CreateNewItemTypes () As Type()" />
      <MemberSignature Language="F#" Value="override this.CreateNewItemTypes : unit -&gt; Type[]" Usage="hotSpotCollectionEditor.CreateNewItemTypes " />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; override cli::array &lt;Type ^&gt; ^ CreateNewItemTypes();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Type[]</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets the multiple data types that the collection editor can create.</summary>
        <returns>A type array of the data types the <see cref="T:System.Web.UI.Design.WebControls.HotSpotCollectionEditor" /> can create.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The types that the <xref:System.Web.UI.Design.WebControls.HotSpotCollectionEditor> object can create are <xref:System.Web.UI.WebControls.CircleHotSpot>, <xref:System.Web.UI.WebControls.RectangleHotSpot>, <xref:System.Web.UI.WebControls.PolygonHotSpot>, and others that can be derived from the <xref:System.Web.UI.WebControls.HotSpot> class.  
  
 ]]></format>
        </remarks>
        <altmember cref="T:System.Web.UI.WebControls.HotSpot" />
        <altmember cref="T:System.Web.UI.WebControls.HotSpotCollection" />
        <altmember cref="M:System.ComponentModel.Design.CollectionEditor.CreateNewItemTypes" />
        <altmember cref="T:System.Web.UI.WebControls.CircleHotSpot" />
        <altmember cref="T:System.Web.UI.WebControls.RectangleHotSpot" />
        <altmember cref="T:System.Web.UI.WebControls.PolygonHotSpot" />
      </Docs>
    </Member>
    <Member MemberName="HelpTopic">
      <MemberSignature Language="C#" Value="protected override string HelpTopic { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string HelpTopic" />
      <MemberSignature Language="DocId" Value="P:System.Web.UI.Design.WebControls.HotSpotCollectionEditor.HelpTopic" />
      <MemberSignature Language="VB.NET" Value="Protected Overrides ReadOnly Property HelpTopic As String" />
      <MemberSignature Language="F#" Value="member this.HelpTopic : string" Usage="System.Web.UI.Design.WebControls.HotSpotCollectionEditor.HelpTopic" />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; virtual property System::String ^ HelpTopic { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the Help topic to display for the <see cref="T:System.Web.UI.Design.WebControls.HotSpotCollectionEditor" /> object.</summary>
        <value>A string that specifies the Help topic to display.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Web.UI.Design.WebControls.HotSpotCollectionEditor.HelpTopic%2A> property gets the name of the Help topic to display when the <xref:System.Web.UI.Design.WebControls.HotSpotCollectionEditor> dialog box **Help** button is clicked or when the **F1** key is pressed.  
  
 ]]></format>
        </remarks>
        <block subset="none" type="overrides">
          <para>Override the <see cref="P:System.Web.UI.Design.WebControls.HotSpotCollectionEditor.HelpTopic" /> property to display a different Help topic.</para>
        </block>
        <altmember cref="T:System.Web.UI.WebControls.HotSpotCollection" />
        <altmember cref="T:System.ComponentModel.Design.CollectionEditor" />
        <altmember cref="P:System.ComponentModel.Design.CollectionEditor.HelpTopic" />
      </Docs>
    </Member>
  </Members>
</Type>