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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DataGridViewComboBoxEditingControl" FullName="System.Windows.Forms.DataGridViewComboBoxEditingControl">
   3   <TypeSignature Language="C#" Value="public class DataGridViewComboBoxEditingControl : System.Windows.Forms.ComboBox, System.Windows.Forms.IDataGridViewEditingControl" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Windows.Forms.ComboBox</BaseTypeName>
  10   </Base>
  11   <Interfaces>
  12     <Interface>
  13       <InterfaceName>System.Windows.Forms.IDataGridViewEditingControl</InterfaceName>
  14     </Interface>
  15   </Interfaces>
  16   <Attributes>
  17     <Attribute>
  18       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
  19     </Attribute>
  20     <Attribute>
  21       <AttributeName>System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)</AttributeName>
  22     </Attribute>
  23   </Attributes>
  24   <Docs>
  25     <since version=".NET 2.0" />
  26     <remarks>
  27       <attribution license="cc4" from="Microsoft" modified="false" />
  28       <para>The <see cref="T:System.Windows.Forms.DataGridViewComboBoxEditingControl" /> class is a specialized type of <see cref="T:System.Windows.Forms.ComboBox" /> that implements the <see cref="T:System.Windows.Forms.IDataGridViewEditingControl" /> interface, allowing it to be hosted in a <see cref="T:System.Windows.Forms.DataGridViewComboBoxCell" /> when the cell is in edit mode. When a <see cref="T:System.Windows.Forms.DataGridViewComboBoxCell" /> is in edit mode, you can retrieve the <see cref="T:System.Windows.Forms.DataGridViewComboBoxEditingControl" /> through the <see cref="P:System.Windows.Forms.DataGridView.EditingControl" /> property of the <see cref="T:System.Windows.Forms.DataGridView" /> control.</para>
  29       <para>Handle the <see cref="E:System.Windows.Forms.DataGridView.EditingControlShowing" /> event to perform custom initialization of the editing control when a cell enters edit mode. To customize the display characteristics of the control, set the properties of the object returned by the <see cref="P:System.Windows.Forms.DataGridViewEditingControlShowingEventArgs.CellStyle" /> property rather than setting the properties of the control returned by the <see cref="P:System.Windows.Forms.DataGridViewEditingControlShowingEventArgs.Control" /> property.</para>
  30     </remarks>
  31     <summary>
  32       <attribution license="cc4" from="Microsoft" modified="false" />
  33       <para>Represents the hosted combo box control in a <see cref="T:System.Windows.Forms.DataGridViewComboBoxCell" />.</para>
  34     </summary>
  35   </Docs>
  36   <Members>
  37     <Member MemberName=".ctor">
  38       <MemberSignature Language="C#" Value="public DataGridViewComboBoxEditingControl ();" />
  39       <MemberType>Constructor</MemberType>
  40       <Parameters />
  41       <Docs>
  42         <since version=".NET 2.0" />
  43         <remarks>
  44           <attribution license="cc4" from="Microsoft" modified="false" />
  45           <para>This default constructor sets the <see cref="P:System.Windows.Forms.Control.TabStop" /> property to false. </para>
  46           <para>Application code typically will not explicitly create instances of the <see cref="T:System.Windows.Forms.DataGridViewComboBoxEditingControl" /> class, because this is performed automatically when the containing <see cref="T:System.Windows.Forms.DataGridViewComboBoxCell" /> is created.</para>
  47         </remarks>
  48         <summary>
  49           <attribution license="cc4" from="Microsoft" modified="false" />
  50           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.DataGridViewComboBoxEditingControl" /> class.</para>
  51         </summary>
  52       </Docs>
  53       <AssemblyInfo>
  54         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  55       </AssemblyInfo>
  56     </Member>
  57     <Member MemberName="ApplyCellStyleToEditingControl">
  58       <MemberSignature Language="C#" Value="public virtual void ApplyCellStyleToEditingControl (System.Windows.Forms.DataGridViewCellStyle dataGridViewCellStyle);" />
  59       <MemberType>Method</MemberType>
  60       <ReturnValue>
  61         <ReturnType>System.Void</ReturnType>
  62       </ReturnValue>
  63       <Parameters>
  64         <Parameter Name="dataGridViewCellStyle" Type="System.Windows.Forms.DataGridViewCellStyle" />
  65       </Parameters>
  66       <Docs>
  67         <since version=".NET 2.0" />
  68         <remarks>
  69           <attribution license="cc4" from="Microsoft" modified="false" />
  70           <para>The <see cref="P:System.Windows.Forms.Control.Font" />, <see cref="P:System.Windows.Forms.Control.BackColor" />, and <see cref="P:System.Windows.Forms.Control.ForeColor" /> properties of the control align with the corresponding properties of the <paramref name="dataGridViewCellStyle" /> parameter value.</para>
  71         </remarks>
  72         <summary>
  73           <attribution license="cc4" from="Microsoft" modified="false" />
  74           <para>Changes the control's user interface (UI) to be consistent with the specified cell style.</para>
  75         </summary>
  76         <param name="dataGridViewCellStyle">
  77           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.DataGridViewCellStyle" /> to use as a pattern for the UI.</param>
  78       </Docs>
  79       <AssemblyInfo>
  80         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  81       </AssemblyInfo>
  82     </Member>
  83     <Member MemberName="EditingControlDataGridView">
  84       <MemberSignature Language="C#" Value="public virtual System.Windows.Forms.DataGridView EditingControlDataGridView { set; get; }" />
  85       <MemberType>Property</MemberType>
  86       <ReturnValue>
  87         <ReturnType>System.Windows.Forms.DataGridView</ReturnType>
  88       </ReturnValue>
  89       <Docs>
  90         <value>To be added.</value>
  91         <since version=".NET 2.0" />
  92         <remarks>
  93           <attribution license="cc4" from="Microsoft" modified="false" />
  94           <para>This property is automatically set when a <see cref="T:System.Windows.Forms.DataGridViewComboBoxColumn" /> or <see cref="T:System.Windows.Forms.DataGridViewComboBoxCell" /> is created within a <see cref="T:System.Windows.Forms.DataGridView" /> or added to a <see cref="T:System.Windows.Forms.DataGridView" />.</para>
  95         </remarks>
  96         <summary>
  97           <attribution license="cc4" from="Microsoft" modified="false" />
  98           <para>Gets or sets the <see cref="T:System.Windows.Forms.DataGridView" /> that contains the combo box control.</para>
  99         </summary>
 100       </Docs>
 101       <AssemblyInfo>
 102         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 103       </AssemblyInfo>
 104     </Member>
 105     <Member MemberName="EditingControlFormattedValue">
 106       <MemberSignature Language="C#" Value="public virtual object EditingControlFormattedValue { set; get; }" />
 107       <MemberType>Property</MemberType>
 108       <ReturnValue>
 109         <ReturnType>System.Object</ReturnType>
 110       </ReturnValue>
 111       <Docs>
 112         <value>To be added.</value>
 113         <since version=".NET 2.0" />
 114         <remarks>
 115           <attribution license="cc4" from="Microsoft" modified="false" />
 116           <para>The <see cref="P:System.Windows.Forms.ComboBox.Text" /> property contains the actual data contained in the control. This data is the string shown in the text box portion of the control. In contrast, the <see cref="M:System.Windows.Forms.DataGridViewComboBoxEditingControl.GetEditingControlFormattedValue(System.Windows.Forms.DataGridViewDataErrorContexts)" /> method returns the formatted representation of this string. Because a combo box uses plain text strings, these two properties are essentially the same.</para>
 117         </remarks>
 118         <summary>
 119           <attribution license="cc4" from="Microsoft" modified="false" />
 120           <para>Gets or sets the formatted representation of the current value of the control.</para>
 121         </summary>
 122       </Docs>
 123       <AssemblyInfo>
 124         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 125       </AssemblyInfo>
 126     </Member>
 127     <Member MemberName="EditingControlRowIndex">
 128       <MemberSignature Language="C#" Value="public virtual int EditingControlRowIndex { set; get; }" />
 129       <MemberType>Property</MemberType>
 130       <ReturnValue>
 131         <ReturnType>System.Int32</ReturnType>
 132       </ReturnValue>
 133       <Docs>
 134         <value>To be added.</value>
 135         <since version=".NET 2.0" />
 136         <remarks>
 137           <attribution license="cc4" from="Microsoft" modified="false" />
 138           <para>The row index of the column headers row is -1.</para>
 139           <para>The row index of a shared row is also -1.</para>
 140         </remarks>
 141         <summary>
 142           <attribution license="cc4" from="Microsoft" modified="false" />
 143           <para>Gets or sets the index of the owning cell's parent row.</para>
 144         </summary>
 145       </Docs>
 146       <AssemblyInfo>
 147         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 148       </AssemblyInfo>
 149     </Member>
 150     <Member MemberName="EditingControlValueChanged">
 151       <MemberSignature Language="C#" Value="public virtual bool EditingControlValueChanged { set; get; }" />
 152       <MemberType>Property</MemberType>
 153       <ReturnValue>
 154         <ReturnType>System.Boolean</ReturnType>
 155       </ReturnValue>
 156       <Docs>
 157         <value>To be added.</value>
 158         <since version=".NET 2.0" />
 159         <remarks>
 160           <attribution license="cc4" from="Microsoft" modified="false" />
 161           <para>The <see cref="P:System.Windows.Forms.DataGridViewComboBoxEditingControl.EditingControlValueChanged" /> property is set to true to specify that the owning cell's value has changed, and the cell may need to be updated to reflect this change. The owning cell or table will reset this property to false after it has updated itself.</para>
 162           <para>When the control is initialized, this property is set to false.</para>
 163         </remarks>
 164         <summary>
 165           <attribution license="cc4" from="Microsoft" modified="false" />
 166           <para>Gets or sets a value indicating whether the current value of the control has changed.</para>
 167         </summary>
 168       </Docs>
 169       <AssemblyInfo>
 170         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 171       </AssemblyInfo>
 172     </Member>
 173     <Member MemberName="EditingControlWantsInputKey">
 174       <MemberSignature Language="C#" Value="public virtual bool EditingControlWantsInputKey (System.Windows.Forms.Keys keyData, bool dataGridViewWantsInputKey);" />
 175       <MemberType>Method</MemberType>
 176       <ReturnValue>
 177         <ReturnType>System.Boolean</ReturnType>
 178       </ReturnValue>
 179       <Parameters>
 180         <Parameter Name="keyData" Type="System.Windows.Forms.Keys" />
 181         <Parameter Name="dataGridViewWantsInputKey" Type="System.Boolean" />
 182       </Parameters>
 183       <Docs>
 184         <since version=".NET 2.0" />
 185         <remarks>
 186           <attribution license="cc4" from="Microsoft" modified="false" />
 187           <para>The <see cref="T:System.Windows.Forms.DataGridView" /> control calls this method to determine whether to handle an input key or let the editing control handle it.</para>
 188           <para>This method returns true if <paramref name="keyData" /> includes the <see cref="F:System.Windows.Forms.Keys.Up" /> or <see cref="F:System.Windows.Forms.Keys.Down" /> values or if the drop-down list is displayed and <paramref name="keyData" /> includes the <see cref="F:System.Windows.Forms.Keys.Escape" /> or <see cref="F:System.Windows.Forms.Keys.Enter" /> values. This method also returns true if <paramref name="dataGridViewWantsInputKey" /> is false. Otherwise, this method returns false.</para>
 189         </remarks>
 190         <summary>
 191           <attribution license="cc4" from="Microsoft" modified="false" />
 192           <para>Determines whether the specified key is a regular input key that the editing control should process or a special key that the <see cref="T:System.Windows.Forms.DataGridView" /> should process.</para>
 193         </summary>
 194         <returns>
 195           <attribution license="cc4" from="Microsoft" modified="false" />
 196           <para>true if the specified key is a regular input key that should be handled by the editing control; otherwise, false.</para>
 197         </returns>
 198         <param name="keyData">
 199           <attribution license="cc4" from="Microsoft" modified="false" />A bitwise combination of <see cref="T:System.Windows.Forms.Keys" /> values that represents the key that was pressed.</param>
 200         <param name="dataGridViewWantsInputKey">
 201           <attribution license="cc4" from="Microsoft" modified="false" />true to indicate that the <see cref="T:System.Windows.Forms.DataGridView" /> control can process the key; otherwise, false.</param>
 202       </Docs>
 203       <AssemblyInfo>
 204         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 205       </AssemblyInfo>
 206     </Member>
 207     <Member MemberName="EditingPanelCursor">
 208       <MemberSignature Language="C#" Value="public virtual System.Windows.Forms.Cursor EditingPanelCursor { get; }" />
 209       <MemberType>Property</MemberType>
 210       <ReturnValue>
 211         <ReturnType>System.Windows.Forms.Cursor</ReturnType>
 212       </ReturnValue>
 213       <Docs>
 214         <value>To be added.</value>
 215         <remarks>To be added.</remarks>
 216         <since version=".NET 2.0" />
 217         <summary>
 218           <attribution license="cc4" from="Microsoft" modified="false" />
 219           <para>Gets the cursor used during editing.</para>
 220         </summary>
 221       </Docs>
 222       <AssemblyInfo>
 223         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 224       </AssemblyInfo>
 225     </Member>
 226     <Member MemberName="GetEditingControlFormattedValue">
 227       <MemberSignature Language="C#" Value="public virtual object GetEditingControlFormattedValue (System.Windows.Forms.DataGridViewDataErrorContexts context);" />
 228       <MemberType>Method</MemberType>
 229       <ReturnValue>
 230         <ReturnType>System.Object</ReturnType>
 231       </ReturnValue>
 232       <Parameters>
 233         <Parameter Name="context" Type="System.Windows.Forms.DataGridViewDataErrorContexts" />
 234       </Parameters>
 235       <Docs>
 236         <remarks>To be added.</remarks>
 237         <since version=".NET 2.0" />
 238         <summary>
 239           <attribution license="cc4" from="Microsoft" modified="false" />
 240           <para>Retrieves the formatted value of the cell.</para>
 241         </summary>
 242         <returns>
 243           <attribution license="cc4" from="Microsoft" modified="false" />
 244           <para>An <see cref="T:System.Object" /> that represents the formatted version of the cell contents.</para>
 245         </returns>
 246         <param name="context">
 247           <attribution license="cc4" from="Microsoft" modified="false" />A bitwise combination of <see cref="T:System.Windows.Forms.DataGridViewDataErrorContexts" /> values that specifies the data error context.</param>
 248       </Docs>
 249       <AssemblyInfo>
 250         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 251       </AssemblyInfo>
 252     </Member>
 253     <Member MemberName="OnSelectedIndexChanged">
 254       <MemberSignature Language="C#" Value="protected override void OnSelectedIndexChanged (EventArgs e);" />
 255       <MemberType>Method</MemberType>
 256       <ReturnValue>
 257         <ReturnType>System.Void</ReturnType>
 258       </ReturnValue>
 259       <Parameters>
 260         <Parameter Name="e" Type="System.EventArgs" />
 261       </Parameters>
 262       <Docs>
 263         <param name="e">To be added.</param>
 264         <summary>To be added.</summary>
 265         <remarks>To be added.</remarks>
 266         <since version=".NET 2.0" />
 267       </Docs>
 268       <AssemblyInfo>
 269         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 270       </AssemblyInfo>
 271     </Member>
 272     <Member MemberName="PrepareEditingControlForEdit">
 273       <MemberSignature Language="C#" Value="public virtual void PrepareEditingControlForEdit (bool selectAll);" />
 274       <MemberType>Method</MemberType>
 275       <ReturnValue>
 276         <ReturnType>System.Void</ReturnType>
 277       </ReturnValue>
 278       <Parameters>
 279         <Parameter Name="selectAll" Type="System.Boolean" />
 280       </Parameters>
 281       <Docs>
 282         <remarks>To be added.</remarks>
 283         <since version=".NET 2.0" />
 284         <summary>
 285           <attribution license="cc4" from="Microsoft" modified="false" />
 286           <para>Prepares the currently selected cell for editing.</para>
 287         </summary>
 288         <param name="selectAll">
 289           <attribution license="cc4" from="Microsoft" modified="false" />true to select all of the cell's content; otherwise, false.</param>
 290       </Docs>
 291       <AssemblyInfo>
 292         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 293       </AssemblyInfo>
 294     </Member>
 295     <Member MemberName="RepositionEditingControlOnValueChange">
 296       <MemberSignature Language="C#" Value="public virtual bool RepositionEditingControlOnValueChange { get; }" />
 297       <MemberType>Property</MemberType>
 298       <ReturnValue>
 299         <ReturnType>System.Boolean</ReturnType>
 300       </ReturnValue>
 301       <Docs>
 302         <value>To be added.</value>
 303         <remarks>To be added.</remarks>
 304         <since version=".NET 2.0" />
 305         <summary>
 306           <attribution license="cc4" from="Microsoft" modified="false" />
 307           <para>Gets a value indicating whether the cell contents need to be repositioned whenever the value changes.</para>
 308         </summary>
 309       </Docs>
 310       <AssemblyInfo>
 311         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 312       </AssemblyInfo>
 313     </Member>
 314   </Members>
 315 </Type>