mcs/class/Managed.Windows.Forms/Documentation/en/System.Windows.Forms/ToolStripDropDownButton.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="ToolStripDropDownButton" FullName="System.Windows.Forms.ToolStripDropDownButton">
   3   <TypeSignature Language="C#" Value="public class ToolStripDropDownButton : System.Windows.Forms.ToolStripDropDownItem" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Windows.Forms.ToolStripDropDownItem</BaseTypeName>
  10   </Base>
  11   <Interfaces />
  12   <Docs>
  13     <since version=".NET 2.0" />
  14     <remarks>
  15       <attribution license="cc4" from="Microsoft" modified="false" />
  16       <para>
  17         <see cref="T:System.Windows.Forms.ToolStripDropDownButton" /> looks like <see cref="T:System.Windows.Forms.ToolStripButton" />, but it shows a drop-down area when the user clicks it. Hide or show the drop-down arrow by setting the <see cref="P:System.Windows.Forms.ToolStripDropDownButton.ShowDropDownArrow" /> property. <see cref="T:System.Windows.Forms.ToolStripDropDownButton" /> hosts a <see cref="T:System.Windows.Forms.ToolStripOverflowButton" /> that displays items that overflow the <see cref="T:System.Windows.Forms.ToolStrip" />.</para>
  18       <para>Use the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" /> to activate familiar drop-down controls such as color pickers. Set the <see cref="P:System.Windows.Forms.ToolStripDropDownButton.ShowDropDownArrow" /> property to true to more clearly indicate to the user that further options are available on the drop-down list.</para>
  19     </remarks>
  20     <summary>
  21       <attribution license="cc4" from="Microsoft" modified="false" />
  22       <para>Represents a control that when clicked displays an associated <see cref="T:System.Windows.Forms.ToolStripDropDown" /> from which the user can select a single item.</para>
  23     </summary>
  24   </Docs>
  25   <Members>
  26     <Member MemberName=".ctor">
  27       <MemberSignature Language="C#" Value="public ToolStripDropDownButton ();" />
  28       <MemberType>Constructor</MemberType>
  29       <Parameters />
  30       <Docs>
  31         <remarks>To be added.</remarks>
  32         <since version=".NET 2.0" />
  33         <summary>
  34           <attribution license="cc4" from="Microsoft" modified="false" />
  35           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" /> class. </para>
  36         </summary>
  37       </Docs>
  38       <AssemblyInfo>
  39         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  40       </AssemblyInfo>
  41     </Member>
  42     <Member MemberName=".ctor">
  43       <MemberSignature Language="C#" Value="public ToolStripDropDownButton (System.Drawing.Image image);" />
  44       <MemberType>Constructor</MemberType>
  45       <Parameters>
  46         <Parameter Name="image" Type="System.Drawing.Image" />
  47       </Parameters>
  48       <Docs>
  49         <remarks>To be added.</remarks>
  50         <since version=".NET 2.0" />
  51         <summary>
  52           <attribution license="cc4" from="Microsoft" modified="false" />
  53           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" /> class that displays the specified image.</para>
  54         </summary>
  55         <param name="image">
  56           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Drawing.Image" /> to be displayed on the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />.</param>
  57       </Docs>
  58       <AssemblyInfo>
  59         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  60       </AssemblyInfo>
  61     </Member>
  62     <Member MemberName=".ctor">
  63       <MemberSignature Language="C#" Value="public ToolStripDropDownButton (string text);" />
  64       <MemberType>Constructor</MemberType>
  65       <Parameters>
  66         <Parameter Name="text" Type="System.String" />
  67       </Parameters>
  68       <Docs>
  69         <remarks>To be added.</remarks>
  70         <since version=".NET 2.0" />
  71         <summary>
  72           <attribution license="cc4" from="Microsoft" modified="false" />
  73           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" /> class that displays the specified text.</para>
  74         </summary>
  75         <param name="text">
  76           <attribution license="cc4" from="Microsoft" modified="false" />The text to be displayed on the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />.</param>
  77       </Docs>
  78       <AssemblyInfo>
  79         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  80       </AssemblyInfo>
  81     </Member>
  82     <Member MemberName=".ctor">
  83       <MemberSignature Language="C#" Value="public ToolStripDropDownButton (string text, System.Drawing.Image image);" />
  84       <MemberType>Constructor</MemberType>
  85       <Parameters>
  86         <Parameter Name="text" Type="System.String" />
  87         <Parameter Name="image" Type="System.Drawing.Image" />
  88       </Parameters>
  89       <Docs>
  90         <remarks>To be added.</remarks>
  91         <since version=".NET 2.0" />
  92         <summary>
  93           <attribution license="cc4" from="Microsoft" modified="false" />
  94           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" /> class that displays the specified text and image.</para>
  95         </summary>
  96         <param name="text">
  97           <attribution license="cc4" from="Microsoft" modified="false" />The text to be displayed on the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />.</param>
  98         <param name="image">
  99           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Drawing.Image" /> to be displayed on the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />.</param>
 100       </Docs>
 101       <AssemblyInfo>
 102         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 103       </AssemblyInfo>
 104     </Member>
 105     <Member MemberName=".ctor">
 106       <MemberSignature Language="C#" Value="public ToolStripDropDownButton (string text, System.Drawing.Image image, EventHandler onClick);" />
 107       <MemberType>Constructor</MemberType>
 108       <Parameters>
 109         <Parameter Name="text" Type="System.String" />
 110         <Parameter Name="image" Type="System.Drawing.Image" />
 111         <Parameter Name="onClick" Type="System.EventHandler" />
 112       </Parameters>
 113       <Docs>
 114         <remarks>To be added.</remarks>
 115         <since version=".NET 2.0" />
 116         <summary>
 117           <attribution license="cc4" from="Microsoft" modified="false" />
 118           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" /> class that displays the specified text and image and raises the Click event.</para>
 119         </summary>
 120         <param name="text">
 121           <attribution license="cc4" from="Microsoft" modified="false" />The text to be displayed on the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />.</param>
 122         <param name="image">
 123           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Drawing.Image" /> to be displayed on the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />.</param>
 124         <param name="onClick">
 125           <attribution license="cc4" from="Microsoft" modified="false" />The event handler for the <see cref="E:System.Windows.Forms.Control.Click" /> event.</param>
 126       </Docs>
 127       <AssemblyInfo>
 128         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 129       </AssemblyInfo>
 130     </Member>
 131     <Member MemberName=".ctor">
 132       <MemberSignature Language="C#" Value="public ToolStripDropDownButton (string text, System.Drawing.Image image, System.Windows.Forms.ToolStripItem[] dropDownItems);" />
 133       <MemberType>Constructor</MemberType>
 134       <Parameters>
 135         <Parameter Name="text" Type="System.String" />
 136         <Parameter Name="image" Type="System.Drawing.Image" />
 137         <Parameter Name="dropDownItems" Type="System.Windows.Forms.ToolStripItem[]">
 138           <Attributes>
 139             <Attribute>
 140               <AttributeName>System.ParamArray</AttributeName>
 141             </Attribute>
 142           </Attributes>
 143         </Parameter>
 144       </Parameters>
 145       <Docs>
 146         <remarks>To be added.</remarks>
 147         <since version=".NET 2.0" />
 148         <summary>
 149           <attribution license="cc4" from="Microsoft" modified="false" />
 150           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" /> class.</para>
 151         </summary>
 152         <param name="text">
 153           <attribution license="cc4" from="Microsoft" modified="false" />The text to be displayed on the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />.</param>
 154         <param name="image">
 155           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Drawing.Image" /> to be displayed on the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />.</param>
 156         <param name="dropDownItems">
 157           <attribution license="cc4" from="Microsoft" modified="false" />An array of type <see cref="T:System.Windows.Forms.ToolStripItem" /> containing the items of the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />.</param>
 158       </Docs>
 159       <AssemblyInfo>
 160         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 161       </AssemblyInfo>
 162     </Member>
 163     <Member MemberName=".ctor">
 164       <MemberSignature Language="C#" Value="public ToolStripDropDownButton (string text, System.Drawing.Image image, EventHandler onClick, string name);" />
 165       <MemberType>Constructor</MemberType>
 166       <Parameters>
 167         <Parameter Name="text" Type="System.String" />
 168         <Parameter Name="image" Type="System.Drawing.Image" />
 169         <Parameter Name="onClick" Type="System.EventHandler" />
 170         <Parameter Name="name" Type="System.String" />
 171       </Parameters>
 172       <Docs>
 173         <remarks>To be added.</remarks>
 174         <since version=".NET 2.0" />
 175         <summary>
 176           <attribution license="cc4" from="Microsoft" modified="false" />
 177           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" /> class that has the specified name, displays the specified text and image, and raises the Click event.</para>
 178         </summary>
 179         <param name="text">
 180           <attribution license="cc4" from="Microsoft" modified="false" />The text to be displayed on the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />.</param>
 181         <param name="image">
 182           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Drawing.Image" /> to be displayed on the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />.</param>
 183         <param name="onClick">
 184           <attribution license="cc4" from="Microsoft" modified="false" />The event handler for the <see cref="E:System.Windows.Forms.Control.Click" /> event.</param>
 185         <param name="name">
 186           <attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />.</param>
 187       </Docs>
 188       <AssemblyInfo>
 189         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 190       </AssemblyInfo>
 191     </Member>
 192     <Member MemberName="AutoToolTip">
 193       <MemberSignature Language="C#" Value="public bool AutoToolTip { set; get; }" />
 194       <MemberType>Property</MemberType>
 195       <ReturnValue>
 196         <ReturnType>System.Boolean</ReturnType>
 197       </ReturnValue>
 198       <Docs>
 199         <value>To be added.</value>
 200         <remarks>To be added.</remarks>
 201         <since version=".NET 2.0" />
 202         <summary>
 203           <attribution license="cc4" from="Microsoft" modified="false" />
 204           <para>Gets or sets a value indicating whether to use the Text property or the <see cref="P:System.Windows.Forms.ToolStripItem.ToolTipText" /> property for the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" /> ToolTip.</para>
 205         </summary>
 206       </Docs>
 207       <AssemblyInfo>
 208         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 209       </AssemblyInfo>
 210       <Attributes>
 211         <Attribute>
 212           <AttributeName>System.ComponentModel.DefaultValue(true)</AttributeName>
 213         </Attribute>
 214       </Attributes>
 215     </Member>
 216     <Member MemberName="CreateDefaultDropDown">
 217       <MemberSignature Language="C#" Value="protected override System.Windows.Forms.ToolStripDropDown CreateDefaultDropDown ();" />
 218       <MemberType>Method</MemberType>
 219       <ReturnValue>
 220         <ReturnType>System.Windows.Forms.ToolStripDropDown</ReturnType>
 221       </ReturnValue>
 222       <Parameters />
 223       <Docs>
 224         <remarks>To be added.</remarks>
 225         <since version=".NET 2.0" />
 226         <summary>
 227           <attribution license="cc4" from="Microsoft" modified="false" />
 228           <para>Creates a generic <see cref="T:System.Windows.Forms.ToolStripDropDown" /> for which events can be defined.</para>
 229         </summary>
 230         <returns>
 231           <attribution license="cc4" from="Microsoft" modified="false" />
 232           <para>A <see cref="T:System.Windows.Forms.ToolStripDropDown" /> for which events can be defined.</para>
 233         </returns>
 234       </Docs>
 235       <AssemblyInfo>
 236         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 237       </AssemblyInfo>
 238     </Member>
 239     <Member MemberName="DefaultAutoToolTip">
 240       <MemberSignature Language="C#" Value="protected override bool DefaultAutoToolTip { get; }" />
 241       <MemberType>Property</MemberType>
 242       <ReturnValue>
 243         <ReturnType>System.Boolean</ReturnType>
 244       </ReturnValue>
 245       <Docs>
 246         <value>To be added.</value>
 247         <remarks>To be added.</remarks>
 248         <since version=".NET 2.0" />
 249         <summary>
 250           <attribution license="cc4" from="Microsoft" modified="false" />
 251           <para>Gets a value indicating whether to display the <see cref="T:System.Windows.Forms.ToolTip" /> that is defined as the default.</para>
 252         </summary>
 253       </Docs>
 254       <AssemblyInfo>
 255         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 256       </AssemblyInfo>
 257     </Member>
 258     <Member MemberName="OnMouseDown">
 259       <MemberSignature Language="C#" Value="protected override void OnMouseDown (System.Windows.Forms.MouseEventArgs e);" />
 260       <MemberType>Method</MemberType>
 261       <ReturnValue>
 262         <ReturnType>System.Void</ReturnType>
 263       </ReturnValue>
 264       <Parameters>
 265         <Parameter Name="e" Type="System.Windows.Forms.MouseEventArgs" />
 266       </Parameters>
 267       <Docs>
 268         <since version=".NET 2.0" />
 269         <remarks>
 270           <attribution license="cc4" from="Microsoft" modified="false" />
 271           <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="f2adaf01-1ed1-42e1-8c31-8d467e7e0ee2">Raising an Event</a></format>.</para>
 272           <para>The <see cref="M:System.Windows.Forms.ToolStripDropDownButton.OnMouseDown(System.Windows.Forms.MouseEventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para>
 273         </remarks>
 274         <summary>
 275           <attribution license="cc4" from="Microsoft" modified="false" />
 276           <para>Raises the <see cref="E:System.Windows.Forms.ToolStripItem.MouseDown" /> event.</para>
 277         </summary>
 278         <param name="e">
 279           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.MouseEventArgs" /> that contains the event data.</param>
 280       </Docs>
 281       <AssemblyInfo>
 282         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 283       </AssemblyInfo>
 284     </Member>
 285     <Member MemberName="OnMouseLeave">
 286       <MemberSignature Language="C#" Value="protected override void OnMouseLeave (EventArgs e);" />
 287       <MemberType>Method</MemberType>
 288       <AssemblyInfo>
 289         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 290       </AssemblyInfo>
 291       <ReturnValue>
 292         <ReturnType>System.Void</ReturnType>
 293       </ReturnValue>
 294       <Parameters>
 295         <Parameter Name="e" Type="System.EventArgs" />
 296       </Parameters>
 297       <Docs>
 298         <remarks>
 299           <attribution license="cc4" from="Microsoft" modified="false" />
 300           <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="f2adaf01-1ed1-42e1-8c31-8d467e7e0ee2">Raising an Event</a></format>.</para>
 301           <para>The <see cref="M:System.Windows.Forms.ToolStripDropDownButton.OnMouseLeave(System.EventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para>
 302         </remarks>
 303         <summary>
 304           <attribution license="cc4" from="Microsoft" modified="false" />
 305           <para>Raises the <see cref="E:System.Windows.Forms.ToolStripItem.MouseLeave" /> event.</para>
 306         </summary>
 307         <param name="e">
 308           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data. </param>
 309       </Docs>
 310     </Member>
 311     <Member MemberName="OnMouseUp">
 312       <MemberSignature Language="C#" Value="protected override void OnMouseUp (System.Windows.Forms.MouseEventArgs e);" />
 313       <MemberType>Method</MemberType>
 314       <AssemblyInfo>
 315         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 316       </AssemblyInfo>
 317       <ReturnValue>
 318         <ReturnType>System.Void</ReturnType>
 319       </ReturnValue>
 320       <Parameters>
 321         <Parameter Name="e" Type="System.Windows.Forms.MouseEventArgs" />
 322       </Parameters>
 323       <Docs>
 324         <remarks>To be added.</remarks>
 325         <summary>
 326           <attribution license="cc4" from="Microsoft" modified="false" />
 327           <para>Raises the <see cref="E:System.Windows.Forms.ToolStripItem.MouseUp" /> event.</para>
 328         </summary>
 329         <param name="e">
 330           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.MouseEventArgs" />  that contains the event data. </param>
 331       </Docs>
 332     </Member>
 333     <Member MemberName="OnPaint">
 334       <MemberSignature Language="C#" Value="protected override void OnPaint (System.Windows.Forms.PaintEventArgs e);" />
 335       <MemberType>Method</MemberType>
 336       <ReturnValue>
 337         <ReturnType>System.Void</ReturnType>
 338       </ReturnValue>
 339       <Parameters>
 340         <Parameter Name="e" Type="System.Windows.Forms.PaintEventArgs" />
 341       </Parameters>
 342       <Docs>
 343         <since version=".NET 2.0" />
 344         <remarks>
 345           <attribution license="cc4" from="Microsoft" modified="false" />
 346           <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="f2adaf01-1ed1-42e1-8c31-8d467e7e0ee2">Raising an Event</a></format>.</para>
 347           <para>The <see cref="M:System.Windows.Forms.ToolStripDropDownButton.OnPaint(System.Windows.Forms.PaintEventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para>
 348         </remarks>
 349         <summary>
 350           <attribution license="cc4" from="Microsoft" modified="false" />
 351           <para>Raises the <see cref="E:System.Windows.Forms.ToolStripItem.Paint" /> event.</para>
 352         </summary>
 353         <param name="e">
 354           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.PaintEventArgs" /> that contains the event data.</param>
 355       </Docs>
 356       <AssemblyInfo>
 357         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 358       </AssemblyInfo>
 359     </Member>
 360     <Member MemberName="ProcessMnemonic">
 361       <MemberSignature Language="C#" Value="protected override bool ProcessMnemonic (char charCode);" />
 362       <MemberType>Method</MemberType>
 363       <AssemblyInfo>
 364         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 365       </AssemblyInfo>
 366       <ReturnValue>
 367         <ReturnType>System.Boolean</ReturnType>
 368       </ReturnValue>
 369       <Parameters>
 370         <Parameter Name="charCode" Type="System.Char" />
 371       </Parameters>
 372       <Docs>
 373         <remarks>To be added.</remarks>
 374         <summary>
 375           <attribution license="cc4" from="Microsoft" modified="false" />
 376           <para>Retrieves a value indicating whether the drop-down list of the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" /> has items.</para>
 377         </summary>
 378         <returns>
 379           <attribution license="cc4" from="Microsoft" modified="false" />
 380           <para>true if the drop-down list has items; otherwise, false.</para>
 381         </returns>
 382         <param name="charCode">
 383           <attribution license="cc4" from="Microsoft" modified="false" />The character to process.</param>
 384       </Docs>
 385     </Member>
 386     <Member MemberName="ShowDropDownArrow">
 387       <MemberSignature Language="C#" Value="public bool ShowDropDownArrow { set; get; }" />
 388       <MemberType>Property</MemberType>
 389       <ReturnValue>
 390         <ReturnType>System.Boolean</ReturnType>
 391       </ReturnValue>
 392       <Docs>
 393         <value>To be added.</value>
 394         <remarks>To be added.</remarks>
 395         <since version=".NET 2.0" />
 396         <summary>
 397           <attribution license="cc4" from="Microsoft" modified="false" />
 398           <para>Gets or sets a value indicating whether an arrow is displayed on the <see cref="T:System.Windows.Forms.ToolStripDropDownButton" />, which indicates that further options are available in a drop-down list.</para>
 399         </summary>
 400       </Docs>
 401       <AssemblyInfo>
 402         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 403       </AssemblyInfo>
 404       <Attributes>
 405         <Attribute>
 406           <AttributeName>System.ComponentModel.DefaultValue(true)</AttributeName>
 407         </Attribute>
 408       </Attributes>
 409     </Member>
 410   </Members>
 411   <Attributes>
 412     <Attribute>
 413       <AttributeName>System.Windows.Forms.Design.ToolStripItemDesignerAvailability(System.Windows.Forms.Design.ToolStripItemDesignerAvailability.ToolStrip | System.Windows.Forms.Design.ToolStripItemDesignerAvailability.StatusStrip)</AttributeName>
 414     </Attribute>
 415   </Attributes>
 416 </Type>