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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DataGridViewSelectedCellCollection" FullName="System.Windows.Forms.DataGridViewSelectedCellCollection">
   3   <TypeSignature Language="C#" Value="public class DataGridViewSelectedCellCollection : System.Windows.Forms.BaseCollection, System.Collections.IList" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Windows.Forms.BaseCollection</BaseTypeName>
  10   </Base>
  11   <Interfaces>
  12     <Interface>
  13       <InterfaceName>System.Collections.IList</InterfaceName>
  14     </Interface>
  15   </Interfaces>
  16   <Attributes>
  17     <Attribute>
  18       <AttributeName>System.ComponentModel.ListBindable(false)</AttributeName>
  19     </Attribute>
  20   </Attributes>
  21   <Docs>
  22     <since version=".NET 2.0" />
  23     <remarks>
  24       <attribution license="cc4" from="Microsoft" modified="false" />
  25       <para>The order of cells in the collection is not guaranteed to match the order in which they were selected.</para>
  26     </remarks>
  27     <summary>
  28       <attribution license="cc4" from="Microsoft" modified="false" />
  29       <para>Represents a collection of cells that are selected in a <see cref="T:System.Windows.Forms.DataGridView" />.</para>
  30     </summary>
  31   </Docs>
  32   <Members>
  33     <Member MemberName="Clear">
  34       <MemberSignature Language="C#" Value="public void Clear ();" />
  35       <MemberType>Method</MemberType>
  36       <ReturnValue>
  37         <ReturnType>System.Void</ReturnType>
  38       </ReturnValue>
  39       <Parameters />
  40       <Docs>
  41         <since version=".NET 2.0" />
  42         <remarks>
  43           <attribution license="cc4" from="Microsoft" modified="false" />
  44           <para>This method is not relevant for this class. You cannot change the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> class directly. To clear the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />, use the <see cref="M:System.Windows.Forms.DataGridView.ClearSelection" /> method.</para>
  45         </remarks>
  46         <summary>
  47           <attribution license="cc4" from="Microsoft" modified="false" />
  48           <para>Clears the collection. </para>
  49         </summary>
  50       </Docs>
  51       <AssemblyInfo>
  52         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  53       </AssemblyInfo>
  54       <Attributes>
  55         <Attribute>
  56           <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
  57         </Attribute>
  58       </Attributes>
  59     </Member>
  60     <Member MemberName="Contains">
  61       <MemberSignature Language="C#" Value="public bool Contains (System.Windows.Forms.DataGridViewCell dataGridViewCell);" />
  62       <MemberType>Method</MemberType>
  63       <ReturnValue>
  64         <ReturnType>System.Boolean</ReturnType>
  65       </ReturnValue>
  66       <Parameters>
  67         <Parameter Name="dataGridViewCell" Type="System.Windows.Forms.DataGridViewCell" />
  68       </Parameters>
  69       <Docs>
  70         <remarks>To be added.</remarks>
  71         <since version=".NET 2.0" />
  72         <summary>
  73           <attribution license="cc4" from="Microsoft" modified="false" />
  74           <para>Determines whether the specified cell is contained in the collection.</para>
  75         </summary>
  76         <returns>
  77           <attribution license="cc4" from="Microsoft" modified="false" />
  78           <para>true if <paramref name="dataGridViewCell" /> is in the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />; otherwise, false.</para>
  79         </returns>
  80         <param name="dataGridViewCell">
  81           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.DataGridViewCell" /> to locate in the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />.</param>
  82       </Docs>
  83       <AssemblyInfo>
  84         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  85       </AssemblyInfo>
  86     </Member>
  87     <Member MemberName="CopyTo">
  88       <MemberSignature Language="C#" Value="public void CopyTo (System.Windows.Forms.DataGridViewCell[] array, int index);" />
  89       <MemberType>Method</MemberType>
  90       <ReturnValue>
  91         <ReturnType>System.Void</ReturnType>
  92       </ReturnValue>
  93       <Parameters>
  94         <Parameter Name="array" Type="System.Windows.Forms.DataGridViewCell[]" />
  95         <Parameter Name="index" Type="System.Int32" />
  96       </Parameters>
  97       <Docs>
  98         <remarks>To be added.</remarks>
  99         <since version=".NET 2.0" />
 100         <summary>
 101           <attribution license="cc4" from="Microsoft" modified="false" />
 102           <para>Copies the elements of the collection to the specified <see cref="T:System.Windows.Forms.DataGridViewCell" /> array, starting at the specified index.</para>
 103         </summary>
 104         <param name="array">
 105           <attribution license="cc4" from="Microsoft" modified="false" />The one-dimensional array of type <see cref="T:System.Windows.Forms.DataGridViewCell" /> that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
 106         <param name="index">
 107           <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index in <paramref name="array" /> at which copying begins.</param>
 108       </Docs>
 109       <AssemblyInfo>
 110         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 111       </AssemblyInfo>
 112     </Member>
 113     <Member MemberName="Insert">
 114       <MemberSignature Language="C#" Value="public void Insert (int index, System.Windows.Forms.DataGridViewCell dataGridViewCell);" />
 115       <MemberType>Method</MemberType>
 116       <ReturnValue>
 117         <ReturnType>System.Void</ReturnType>
 118       </ReturnValue>
 119       <Parameters>
 120         <Parameter Name="index" Type="System.Int32" />
 121         <Parameter Name="dataGridViewCell" Type="System.Windows.Forms.DataGridViewCell" />
 122       </Parameters>
 123       <Docs>
 124         <since version=".NET 2.0" />
 125         <remarks>
 126           <attribution license="cc4" from="Microsoft" modified="false" />
 127           <para>This method is not relevant for this class. You cannot change the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> class directly. To add a cell to the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />, use the <see cref="P:System.Windows.Forms.DataGridViewCell.Selected" /> property.</para>
 128         </remarks>
 129         <summary>
 130           <attribution license="cc4" from="Microsoft" modified="false" />
 131           <para>Inserts a cell into the collection.</para>
 132         </summary>
 133         <param name="index">
 134           <attribution license="cc4" from="Microsoft" modified="false" />The index at which <paramref name="dataGridViewCell" /> should be inserted.</param>
 135         <param name="dataGridViewCell">
 136           <attribution license="cc4" from="Microsoft" modified="false" />The object to be added to the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />.</param>
 137       </Docs>
 138       <AssemblyInfo>
 139         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 140       </AssemblyInfo>
 141       <Attributes>
 142         <Attribute>
 143           <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
 144         </Attribute>
 145       </Attributes>
 146     </Member>
 147     <Member MemberName="Item">
 148       <MemberSignature Language="C#" Value="public System.Windows.Forms.DataGridViewCell this[int index] { get; }" />
 149       <MemberType>Property</MemberType>
 150       <ReturnValue>
 151         <ReturnType>System.Windows.Forms.DataGridViewCell</ReturnType>
 152       </ReturnValue>
 153       <Parameters>
 154         <Parameter Name="index" Type="System.Int32" />
 155       </Parameters>
 156       <Docs>
 157         <param name="index">To be added.</param>
 158         <summary>To be added.</summary>
 159         <value>To be added.</value>
 160         <remarks>To be added.</remarks>
 161         <since version=".NET 2.0" />
 162       </Docs>
 163       <AssemblyInfo>
 164         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 165       </AssemblyInfo>
 166     </Member>
 167     <Member MemberName="List">
 168       <MemberSignature Language="C#" Value="protected override System.Collections.ArrayList List { get; }" />
 169       <MemberType>Property</MemberType>
 170       <AssemblyInfo>
 171         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 172       </AssemblyInfo>
 173       <ReturnValue>
 174         <ReturnType>System.Collections.ArrayList</ReturnType>
 175       </ReturnValue>
 176       <Docs>
 177         <value>To be added.</value>
 178         <remarks>To be added.</remarks>
 179         <summary>
 180           <attribution license="cc4" from="Microsoft" modified="false" />
 181           <para>Gets a list of elements in the collection.</para>
 182         </summary>
 183       </Docs>
 184     </Member>
 185     <Member MemberName="System.Collections.IList.Add">
 186       <MemberSignature Language="C#" Value="int IList.Add (object value);" />
 187       <MemberType>Method</MemberType>
 188       <AssemblyInfo>
 189         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 190       </AssemblyInfo>
 191       <ReturnValue>
 192         <ReturnType>System.Int32</ReturnType>
 193       </ReturnValue>
 194       <Parameters>
 195         <Parameter Name="value" Type="System.Object" />
 196       </Parameters>
 197       <Docs>
 198         <remarks>
 199           <attribution license="cc4" from="Microsoft" modified="false" />
 200           <para>You cannot change the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> class directly. To add a cell to the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />, use the <see cref="P:System.Windows.Forms.DataGridViewCell.Selected" /> property.</para>
 201           <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
 202         </remarks>
 203         <summary>
 204           <attribution license="cc4" from="Microsoft" modified="false" />
 205           <para>Implements the <see cref="M:System.Collections.IList.Add(System.Object)" /> method. Always throws <see cref="T:System.NotSupportedException" />.</para>
 206         </summary>
 207         <returns>
 208           <attribution license="cc4" from="Microsoft" modified="false" />
 209           <para>The position into which the new element was inserted.</para>
 210         </returns>
 211         <param name="value">
 212           <attribution license="cc4" from="Microsoft" modified="false" />The item to be added to the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />.</param>
 213       </Docs>
 214     </Member>
 215     <Member MemberName="System.Collections.IList.Clear">
 216       <MemberSignature Language="C#" Value="void IList.Clear ();" />
 217       <MemberType>Method</MemberType>
 218       <AssemblyInfo>
 219         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 220       </AssemblyInfo>
 221       <ReturnValue>
 222         <ReturnType>System.Void</ReturnType>
 223       </ReturnValue>
 224       <Parameters />
 225       <Docs>
 226         <remarks>
 227           <attribution license="cc4" from="Microsoft" modified="false" />
 228           <para>You cannot change the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> class directly. To clear the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />, use the <see cref="M:System.Windows.Forms.DataGridView.ClearSelection" /> method.</para>
 229           <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
 230         </remarks>
 231         <summary>
 232           <attribution license="cc4" from="Microsoft" modified="false" />
 233           <para>Implements the <see cref="M:System.Collections.IList.Clear" /> method. Always throws <see cref="T:System.NotSupportedException" />.</para>
 234         </summary>
 235       </Docs>
 236     </Member>
 237     <Member MemberName="System.Collections.IList.Contains">
 238       <MemberSignature Language="C#" Value="bool IList.Contains (object value);" />
 239       <MemberType>Method</MemberType>
 240       <AssemblyInfo>
 241         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 242       </AssemblyInfo>
 243       <ReturnValue>
 244         <ReturnType>System.Boolean</ReturnType>
 245       </ReturnValue>
 246       <Parameters>
 247         <Parameter Name="value" Type="System.Object" />
 248       </Parameters>
 249       <Docs>
 250         <remarks>
 251           <attribution license="cc4" from="Microsoft" modified="false" />
 252           <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
 253         </remarks>
 254         <summary>
 255           <attribution license="cc4" from="Microsoft" modified="false" />
 256           <para>Determines whether the specified cell is contained in the collection.</para>
 257         </summary>
 258         <returns>
 259           <attribution license="cc4" from="Microsoft" modified="false" />
 260           <para>true if <paramref name="value" /> is in the collection; otherwise, false.</para>
 261         </returns>
 262         <param name="value">
 263           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DataGridViewCell" /> to locate in the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />.</param>
 264       </Docs>
 265     </Member>
 266     <Member MemberName="System.Collections.IList.IndexOf">
 267       <MemberSignature Language="C#" Value="int IList.IndexOf (object value);" />
 268       <MemberType>Method</MemberType>
 269       <AssemblyInfo>
 270         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 271       </AssemblyInfo>
 272       <ReturnValue>
 273         <ReturnType>System.Int32</ReturnType>
 274       </ReturnValue>
 275       <Parameters>
 276         <Parameter Name="value" Type="System.Object" />
 277       </Parameters>
 278       <Docs>
 279         <remarks>
 280           <attribution license="cc4" from="Microsoft" modified="false" />
 281           <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
 282         </remarks>
 283         <summary>
 284           <attribution license="cc4" from="Microsoft" modified="false" />
 285           <para>Returns the index of the specified cell.</para>
 286         </summary>
 287         <returns>
 288           <attribution license="cc4" from="Microsoft" modified="false" />
 289           <para>The zero-based index of the <paramref name="value" /> parameter if it is found in the collection; otherwise, -1.</para>
 290         </returns>
 291         <param name="value">
 292           <attribution license="cc4" from="Microsoft" modified="false" />The cell to locate in the collection.</param>
 293       </Docs>
 294     </Member>
 295     <Member MemberName="System.Collections.IList.Insert">
 296       <MemberSignature Language="C#" Value="void IList.Insert (int index, object value);" />
 297       <MemberType>Method</MemberType>
 298       <AssemblyInfo>
 299         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 300       </AssemblyInfo>
 301       <ReturnValue>
 302         <ReturnType>System.Void</ReturnType>
 303       </ReturnValue>
 304       <Parameters>
 305         <Parameter Name="index" Type="System.Int32" />
 306         <Parameter Name="value" Type="System.Object" />
 307       </Parameters>
 308       <Docs>
 309         <remarks>
 310           <attribution license="cc4" from="Microsoft" modified="false" />
 311           <para>You cannot change the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> class directly. To add a cell to the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />, use the <see cref="P:System.Windows.Forms.DataGridViewCell.Selected" /> property.</para>
 312           <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
 313         </remarks>
 314         <summary>
 315           <attribution license="cc4" from="Microsoft" modified="false" />
 316           <para>Implements the <see cref="M:System.Collections.IList.Insert(System.Int32,System.Object)" /> method. Always throws <see cref="T:System.NotSupportedException" />.</para>
 317         </summary>
 318         <param name="index">
 319           <attribution license="cc4" from="Microsoft" modified="false" />The index at which <paramref name="value" /> should be inserted.</param>
 320         <param name="value">
 321           <attribution license="cc4" from="Microsoft" modified="false" />The object to be added to the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />.</param>
 322       </Docs>
 323     </Member>
 324     <Member MemberName="System.Collections.IList.IsFixedSize">
 325       <MemberSignature Language="C#" Value="bool System.Collections.IList.IsFixedSize { get; }" />
 326       <MemberType>Property</MemberType>
 327       <AssemblyInfo>
 328         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 329       </AssemblyInfo>
 330       <ReturnValue>
 331         <ReturnType>System.Boolean</ReturnType>
 332       </ReturnValue>
 333       <Docs>
 334         <value>To be added.</value>
 335         <remarks>
 336           <attribution license="cc4" from="Microsoft" modified="false" />
 337           <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
 338         </remarks>
 339         <summary>
 340           <attribution license="cc4" from="Microsoft" modified="false" />
 341           <para>Gets a value indicating whether the collection has a fixed size.</para>
 342         </summary>
 343       </Docs>
 344     </Member>
 345     <Member MemberName="System.Collections.IList.Item">
 346       <MemberSignature Language="C#" Value="object System.Collections.IList.Item[int index] { set; get; }" />
 347       <MemberType>Property</MemberType>
 348       <AssemblyInfo>
 349         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 350       </AssemblyInfo>
 351       <ReturnValue>
 352         <ReturnType>System.Object</ReturnType>
 353       </ReturnValue>
 354       <Parameters>
 355         <Parameter Name="index" Type="System.Int32" />
 356       </Parameters>
 357       <Docs>
 358         <param name="index">To be added.</param>
 359         <summary>To be added.</summary>
 360         <value>To be added.</value>
 361         <remarks>To be added.</remarks>
 362       </Docs>
 363     </Member>
 364     <Member MemberName="System.Collections.IList.Remove">
 365       <MemberSignature Language="C#" Value="void IList.Remove (object value);" />
 366       <MemberType>Method</MemberType>
 367       <AssemblyInfo>
 368         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 369       </AssemblyInfo>
 370       <ReturnValue>
 371         <ReturnType>System.Void</ReturnType>
 372       </ReturnValue>
 373       <Parameters>
 374         <Parameter Name="value" Type="System.Object" />
 375       </Parameters>
 376       <Docs>
 377         <remarks>
 378           <attribution license="cc4" from="Microsoft" modified="false" />
 379           <para>You cannot change the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> class directly. To remove a cell from the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />, use the <see cref="P:System.Windows.Forms.DataGridViewCell.Selected" /> property.</para>
 380           <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
 381         </remarks>
 382         <summary>
 383           <attribution license="cc4" from="Microsoft" modified="false" />
 384           <para>Implements the <see cref="M:System.Collections.IList.Remove(System.Object)" /> method. Always throws <see cref="T:System.NotSupportedException" />.</para>
 385         </summary>
 386         <param name="value">
 387           <attribution license="cc4" from="Microsoft" modified="false" />The object to be removed from the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />.</param>
 388       </Docs>
 389     </Member>
 390     <Member MemberName="System.Collections.IList.RemoveAt">
 391       <MemberSignature Language="C#" Value="void IList.RemoveAt (int index);" />
 392       <MemberType>Method</MemberType>
 393       <AssemblyInfo>
 394         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 395       </AssemblyInfo>
 396       <ReturnValue>
 397         <ReturnType>System.Void</ReturnType>
 398       </ReturnValue>
 399       <Parameters>
 400         <Parameter Name="index" Type="System.Int32" />
 401       </Parameters>
 402       <Docs>
 403         <remarks>
 404           <attribution license="cc4" from="Microsoft" modified="false" />
 405           <para>You cannot change the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> class directly. To remove a cell from the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />, use the <see cref="P:System.Windows.Forms.DataGridViewCell.Selected" /> property.</para>
 406           <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
 407         </remarks>
 408         <summary>
 409           <attribution license="cc4" from="Microsoft" modified="false" />
 410           <para>Implements the <see cref="M:System.Collections.IList.RemoveAt(System.Int32)" /> method. Always throws <see cref="T:System.NotSupportedException" />.</para>
 411         </summary>
 412         <param name="index">
 413           <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index of the item to remove.</param>
 414       </Docs>
 415     </Member>
 416   </Members>
 417 </Type>