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         <returns>To be added.</returns>
  71         <remarks>To be added.</remarks>
  72         <since version=".NET 2.0" />
  73         <summary>
  74           <attribution license="cc4" from="Microsoft" modified="false" />
  75           <para>Determines whether the specified cell is contained in the collection.</para>
  76         </summary>
  77         <param name="dataGridViewCell">
  78           <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>
  79       </Docs>
  80       <AssemblyInfo>
  81         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  82       </AssemblyInfo>
  83     </Member>
  84     <Member MemberName="CopyTo">
  85       <MemberSignature Language="C#" Value="public void CopyTo (System.Windows.Forms.DataGridViewCell[] array, int index);" />
  86       <MemberType>Method</MemberType>
  87       <ReturnValue>
  88         <ReturnType>System.Void</ReturnType>
  89       </ReturnValue>
  90       <Parameters>
  91         <Parameter Name="array" Type="System.Windows.Forms.DataGridViewCell[]" />
  92         <Parameter Name="index" Type="System.Int32" />
  93       </Parameters>
  94       <Docs>
  95         <remarks>To be added.</remarks>
  96         <since version=".NET 2.0" />
  97         <summary>
  98           <attribution license="cc4" from="Microsoft" modified="false" />
  99           <para>Copies the elements of the collection to the specified <see cref="T:System.Windows.Forms.DataGridViewCell" /> array, starting at the specified index.</para>
 100         </summary>
 101         <param name="array">
 102           <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>
 103         <param name="index">
 104           <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index in <paramref name="array" /> at which copying begins.</param>
 105       </Docs>
 106       <AssemblyInfo>
 107         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 108       </AssemblyInfo>
 109     </Member>
 110     <Member MemberName="Insert">
 111       <MemberSignature Language="C#" Value="public void Insert (int index, System.Windows.Forms.DataGridViewCell dataGridViewCell);" />
 112       <MemberType>Method</MemberType>
 113       <ReturnValue>
 114         <ReturnType>System.Void</ReturnType>
 115       </ReturnValue>
 116       <Parameters>
 117         <Parameter Name="index" Type="System.Int32" />
 118         <Parameter Name="dataGridViewCell" Type="System.Windows.Forms.DataGridViewCell" />
 119       </Parameters>
 120       <Docs>
 121         <since version=".NET 2.0" />
 122         <remarks>
 123           <attribution license="cc4" from="Microsoft" modified="false" />
 124           <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>
 125         </remarks>
 126         <summary>
 127           <attribution license="cc4" from="Microsoft" modified="false" />
 128           <para>Inserts a cell into the collection.</para>
 129         </summary>
 130         <param name="index">
 131           <attribution license="cc4" from="Microsoft" modified="false" />The index at which <paramref name="dataGridViewCell" /> should be inserted.</param>
 132         <param name="dataGridViewCell">
 133           <attribution license="cc4" from="Microsoft" modified="false" />The object to be added to the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />.</param>
 134       </Docs>
 135       <AssemblyInfo>
 136         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 137       </AssemblyInfo>
 138       <Attributes>
 139         <Attribute>
 140           <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
 141         </Attribute>
 142       </Attributes>
 143     </Member>
 144     <Member MemberName="Item">
 145       <MemberSignature Language="C#" Value="public System.Windows.Forms.DataGridViewCell this[int index] { get; }" />
 146       <MemberType>Property</MemberType>
 147       <ReturnValue>
 148         <ReturnType>System.Windows.Forms.DataGridViewCell</ReturnType>
 149       </ReturnValue>
 150       <Parameters>
 151         <Parameter Name="index" Type="System.Int32" />
 152       </Parameters>
 153       <Docs>
 154         <param name="index">To be added.</param>
 155         <summary>To be added.</summary>
 156         <value>To be added.</value>
 157         <remarks>To be added.</remarks>
 158         <since version=".NET 2.0" />
 159       </Docs>
 160       <AssemblyInfo>
 161         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 162       </AssemblyInfo>
 163     </Member>
 164     <Member MemberName="List">
 165       <MemberSignature Language="C#" Value="protected override System.Collections.ArrayList List { get; }" />
 166       <MemberType>Property</MemberType>
 167       <AssemblyInfo>
 168         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 169       </AssemblyInfo>
 170       <ReturnValue>
 171         <ReturnType>System.Collections.ArrayList</ReturnType>
 172       </ReturnValue>
 173       <Docs>
 174         <value>To be added.</value>
 175         <remarks>To be added.</remarks>
 176         <summary>
 177           <attribution license="cc4" from="Microsoft" modified="false" />
 178           <para>Gets a list of elements in the collection.</para>
 179         </summary>
 180       </Docs>
 181     </Member>
 182     <Member MemberName="System.Collections.IList.Add">
 183       <MemberSignature Language="C#" Value="int IList.Add (object value);" />
 184       <MemberType>Method</MemberType>
 185       <AssemblyInfo>
 186         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 187       </AssemblyInfo>
 188       <ReturnValue>
 189         <ReturnType>System.Int32</ReturnType>
 190       </ReturnValue>
 191       <Parameters>
 192         <Parameter Name="value" Type="System.Object" />
 193       </Parameters>
 194       <Docs>
 195         <returns>To be added.</returns>
 196         <remarks>
 197           <attribution license="cc4" from="Microsoft" modified="false" />
 198           <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>
 199           <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>
 200         </remarks>
 201         <summary>
 202           <attribution license="cc4" from="Microsoft" modified="false" />
 203           <para>Implements the <see cref="M:System.Collections.IList.Add(System.Object)" /> method. Always throws <see cref="T:System.NotSupportedException" />.</para>
 204         </summary>
 205         <param name="value">
 206           <attribution license="cc4" from="Microsoft" modified="false" />The item to be added to the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />.</param>
 207       </Docs>
 208     </Member>
 209     <Member MemberName="System.Collections.IList.Clear">
 210       <MemberSignature Language="C#" Value="void IList.Clear ();" />
 211       <MemberType>Method</MemberType>
 212       <AssemblyInfo>
 213         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 214       </AssemblyInfo>
 215       <ReturnValue>
 216         <ReturnType>System.Void</ReturnType>
 217       </ReturnValue>
 218       <Parameters />
 219       <Docs>
 220         <remarks>
 221           <attribution license="cc4" from="Microsoft" modified="false" />
 222           <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>
 223           <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>
 224         </remarks>
 225         <summary>
 226           <attribution license="cc4" from="Microsoft" modified="false" />
 227           <para>Implements the <see cref="M:System.Collections.IList.Clear" /> method. Always throws <see cref="T:System.NotSupportedException" />.</para>
 228         </summary>
 229       </Docs>
 230     </Member>
 231     <Member MemberName="System.Collections.IList.Contains">
 232       <MemberSignature Language="C#" Value="bool IList.Contains (object value);" />
 233       <MemberType>Method</MemberType>
 234       <AssemblyInfo>
 235         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 236       </AssemblyInfo>
 237       <ReturnValue>
 238         <ReturnType>System.Boolean</ReturnType>
 239       </ReturnValue>
 240       <Parameters>
 241         <Parameter Name="value" Type="System.Object" />
 242       </Parameters>
 243       <Docs>
 244         <returns>To be added.</returns>
 245         <remarks>
 246           <attribution license="cc4" from="Microsoft" modified="false" />
 247           <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>
 248         </remarks>
 249         <summary>
 250           <attribution license="cc4" from="Microsoft" modified="false" />
 251           <para>Determines whether the specified cell is contained in the collection.</para>
 252         </summary>
 253         <param name="value">
 254           <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>
 255       </Docs>
 256     </Member>
 257     <Member MemberName="System.Collections.IList.IndexOf">
 258       <MemberSignature Language="C#" Value="int IList.IndexOf (object value);" />
 259       <MemberType>Method</MemberType>
 260       <AssemblyInfo>
 261         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 262       </AssemblyInfo>
 263       <ReturnValue>
 264         <ReturnType>System.Int32</ReturnType>
 265       </ReturnValue>
 266       <Parameters>
 267         <Parameter Name="value" Type="System.Object" />
 268       </Parameters>
 269       <Docs>
 270         <returns>To be added.</returns>
 271         <remarks>
 272           <attribution license="cc4" from="Microsoft" modified="false" />
 273           <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>
 274         </remarks>
 275         <summary>
 276           <attribution license="cc4" from="Microsoft" modified="false" />
 277           <para>Returns the index of the specified cell.</para>
 278         </summary>
 279         <param name="value">
 280           <attribution license="cc4" from="Microsoft" modified="false" />The cell to locate in the collection.</param>
 281       </Docs>
 282     </Member>
 283     <Member MemberName="System.Collections.IList.Insert">
 284       <MemberSignature Language="C#" Value="void IList.Insert (int index, object value);" />
 285       <MemberType>Method</MemberType>
 286       <AssemblyInfo>
 287         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 288       </AssemblyInfo>
 289       <ReturnValue>
 290         <ReturnType>System.Void</ReturnType>
 291       </ReturnValue>
 292       <Parameters>
 293         <Parameter Name="index" Type="System.Int32" />
 294         <Parameter Name="value" Type="System.Object" />
 295       </Parameters>
 296       <Docs>
 297         <remarks>
 298           <attribution license="cc4" from="Microsoft" modified="false" />
 299           <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>
 300           <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>
 301         </remarks>
 302         <summary>
 303           <attribution license="cc4" from="Microsoft" modified="false" />
 304           <para>Implements the <see cref="M:System.Collections.IList.Insert(System.Int32,System.Object)" /> method. Always throws <see cref="T:System.NotSupportedException" />.</para>
 305         </summary>
 306         <param name="index">
 307           <attribution license="cc4" from="Microsoft" modified="false" />The index at which <paramref name="value" /> should be inserted.</param>
 308         <param name="value">
 309           <attribution license="cc4" from="Microsoft" modified="false" />The object to be added to the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />.</param>
 310       </Docs>
 311     </Member>
 312     <Member MemberName="System.Collections.IList.IsFixedSize">
 313       <MemberSignature Language="C#" Value="bool System.Collections.IList.IsFixedSize { get; }" />
 314       <MemberType>Property</MemberType>
 315       <AssemblyInfo>
 316         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 317       </AssemblyInfo>
 318       <ReturnValue>
 319         <ReturnType>System.Boolean</ReturnType>
 320       </ReturnValue>
 321       <Docs>
 322         <value>To be added.</value>
 323         <remarks>
 324           <attribution license="cc4" from="Microsoft" modified="false" />
 325           <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>
 326         </remarks>
 327         <summary>
 328           <attribution license="cc4" from="Microsoft" modified="false" />
 329           <para>Gets a value indicating whether the collection has a fixed size.</para>
 330         </summary>
 331       </Docs>
 332     </Member>
 333     <Member MemberName="System.Collections.IList.Item">
 334       <MemberSignature Language="C#" Value="object System.Collections.IList.Item[int index] { set; get; }" />
 335       <MemberType>Property</MemberType>
 336       <AssemblyInfo>
 337         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 338       </AssemblyInfo>
 339       <ReturnValue>
 340         <ReturnType>System.Object</ReturnType>
 341       </ReturnValue>
 342       <Parameters>
 343         <Parameter Name="index" Type="System.Int32" />
 344       </Parameters>
 345       <Docs>
 346         <param name="index">To be added.</param>
 347         <summary>To be added.</summary>
 348         <value>To be added.</value>
 349         <remarks>To be added.</remarks>
 350       </Docs>
 351     </Member>
 352     <Member MemberName="System.Collections.IList.Remove">
 353       <MemberSignature Language="C#" Value="void IList.Remove (object value);" />
 354       <MemberType>Method</MemberType>
 355       <AssemblyInfo>
 356         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 357       </AssemblyInfo>
 358       <ReturnValue>
 359         <ReturnType>System.Void</ReturnType>
 360       </ReturnValue>
 361       <Parameters>
 362         <Parameter Name="value" Type="System.Object" />
 363       </Parameters>
 364       <Docs>
 365         <remarks>
 366           <attribution license="cc4" from="Microsoft" modified="false" />
 367           <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>
 368           <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>
 369         </remarks>
 370         <summary>
 371           <attribution license="cc4" from="Microsoft" modified="false" />
 372           <para>Implements the <see cref="M:System.Collections.IList.Remove(System.Object)" /> method. Always throws <see cref="T:System.NotSupportedException" />.</para>
 373         </summary>
 374         <param name="value">
 375           <attribution license="cc4" from="Microsoft" modified="false" />The object to be removed from the <see cref="T:System.Windows.Forms.DataGridViewSelectedCellCollection" />.</param>
 376       </Docs>
 377     </Member>
 378     <Member MemberName="System.Collections.IList.RemoveAt">
 379       <MemberSignature Language="C#" Value="void IList.RemoveAt (int index);" />
 380       <MemberType>Method</MemberType>
 381       <AssemblyInfo>
 382         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 383       </AssemblyInfo>
 384       <ReturnValue>
 385         <ReturnType>System.Void</ReturnType>
 386       </ReturnValue>
 387       <Parameters>
 388         <Parameter Name="index" Type="System.Int32" />
 389       </Parameters>
 390       <Docs>
 391         <remarks>
 392           <attribution license="cc4" from="Microsoft" modified="false" />
 393           <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>
 394           <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>
 395         </remarks>
 396         <summary>
 397           <attribution license="cc4" from="Microsoft" modified="false" />
 398           <para>Implements the <see cref="M:System.Collections.IList.RemoveAt(System.Int32)" /> method. Always throws <see cref="T:System.NotSupportedException" />.</para>
 399         </summary>
 400         <param name="index">
 401           <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index of the item to remove.</param>
 402       </Docs>
 403     </Member>
 404   </Members>
 405 </Type>