1 <?xml version="1.0" encoding="utf-8"?>
2 <Type Name="DataGridViewCellCollection" FullName="System.Windows.Forms.DataGridViewCellCollection">
3 <TypeSignature Language="C#" Value="public class DataGridViewCellCollection : System.Windows.Forms.BaseCollection, System.Collections.IList" />
5 <AssemblyName>System.Windows.Forms</AssemblyName>
6 <AssemblyVersion>2.0.0.0</AssemblyVersion>
9 <BaseTypeName>System.Windows.Forms.BaseCollection</BaseTypeName>
13 <InterfaceName>System.Collections.IList</InterfaceName>
18 <AttributeName>System.ComponentModel.ListBindable(false)</AttributeName>
22 <since version=".NET 2.0" />
24 <attribution license="cc4" from="Microsoft" modified="false" />
26 <see cref="T:System.Windows.Forms.DataGridViewCellCollection" /> objects are retrieved by the <see cref="P:System.Windows.Forms.DataGridViewRow.Cells" /> property.</para>
29 <attribution license="cc4" from="Microsoft" modified="false" />
30 <para>Represents a collection of cells in a <see cref="T:System.Windows.Forms.DataGridViewRow" />.</para>
34 <Member MemberName=".ctor">
35 <MemberSignature Language="C#" Value="public DataGridViewCellCollection (System.Windows.Forms.DataGridViewRow dataGridViewRow);" />
36 <MemberType>Constructor</MemberType>
38 <Parameter Name="dataGridViewRow" Type="System.Windows.Forms.DataGridViewRow" />
41 <remarks>To be added.</remarks>
42 <since version=".NET 2.0" />
44 <attribution license="cc4" from="Microsoft" modified="false" />
45 <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.DataGridViewCellCollection" /> class.</para>
47 <param name="dataGridViewRow">
48 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.DataGridViewRow" /> that owns the collection.</param>
51 <AssemblyVersion>2.0.0.0</AssemblyVersion>
54 <Member MemberName="Add">
55 <MemberSignature Language="C#" Value="public virtual int Add (System.Windows.Forms.DataGridViewCell dataGridViewCell);" />
56 <MemberType>Method</MemberType>
58 <ReturnType>System.Int32</ReturnType>
61 <Parameter Name="dataGridViewCell" Type="System.Windows.Forms.DataGridViewCell" />
64 <since version=".NET 2.0" />
66 <attribution license="cc4" from="Microsoft" modified="false" />
67 <para>Use this method to populate a <see cref="T:System.Windows.Forms.DataGridViewRow" /> with cells before you add the row to a <see cref="T:System.Windows.Forms.DataGridView" /> control. Once you add the row to a control, the number of cells it contains always matches the number of columns in the control, so this method is no longer useful.</para>
70 <attribution license="cc4" from="Microsoft" modified="false" />
71 <para>Adds a cell to the collection.</para>
74 <attribution license="cc4" from="Microsoft" modified="false" />
75 <para>The position in which to insert the new element.</para>
77 <param name="dataGridViewCell">
78 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DataGridViewCell" /> to add to the collection.</param>
81 <AssemblyVersion>2.0.0.0</AssemblyVersion>
84 <Member MemberName="AddRange">
85 <MemberSignature Language="C#" Value="public virtual void AddRange (System.Windows.Forms.DataGridViewCell[] dataGridViewCells);" />
86 <MemberType>Method</MemberType>
88 <ReturnType>System.Void</ReturnType>
91 <Parameter Name="dataGridViewCells" Type="System.Windows.Forms.DataGridViewCell[]">
94 <AttributeName>System.ParamArray</AttributeName>
100 <since version=".NET 2.0" />
102 <attribution license="cc4" from="Microsoft" modified="false" />
103 <para>Use this method to populate a <see cref="T:System.Windows.Forms.DataGridViewRow" /> with cells before you add the row to a <see cref="T:System.Windows.Forms.DataGridView" /> control. Once you add the row to a control, the number of cells it contains always matches the number of columns in the control, so this method is no longer useful. </para>
106 <attribution license="cc4" from="Microsoft" modified="false" />
107 <para>Adds an array of cells to the collection.</para>
109 <param name="dataGridViewCells">
110 <attribution license="cc4" from="Microsoft" modified="false" />The array of <see cref="T:System.Windows.Forms.DataGridViewCell" /> objects to add to the collection.</param>
113 <AssemblyVersion>2.0.0.0</AssemblyVersion>
117 <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
121 <Member MemberName="Clear">
122 <MemberSignature Language="C#" Value="public virtual void Clear ();" />
123 <MemberType>Method</MemberType>
125 <ReturnType>System.Void</ReturnType>
129 <since version=".NET 2.0" />
131 <attribution license="cc4" from="Microsoft" modified="false" />
132 <para>Use this method to alter the collection before you add the containing row to a <see cref="T:System.Windows.Forms.DataGridView" /> control. Once you add the row to a control, the number of cells it contains always matches the number of columns in the control, so this method is no longer useful. </para>
135 <attribution license="cc4" from="Microsoft" modified="false" />
136 <para>Clears all cells from the collection.</para>
140 <AssemblyVersion>2.0.0.0</AssemblyVersion>
143 <Member MemberName="CollectionChanged">
144 <MemberSignature Language="C#" Value="public event System.ComponentModel.CollectionChangeEventHandler CollectionChanged;" />
145 <MemberType>Event</MemberType>
147 <ReturnType>System.ComponentModel.CollectionChangeEventHandler</ReturnType>
150 <remarks>To be added.</remarks>
151 <since version=".NET 2.0" />
153 <attribution license="cc4" from="Microsoft" modified="false" />
154 <para>Occurs when the collection is changed. </para>
158 <AssemblyVersion>2.0.0.0</AssemblyVersion>
161 <Member MemberName="Contains">
162 <MemberSignature Language="C#" Value="public virtual bool Contains (System.Windows.Forms.DataGridViewCell dataGridViewCell);" />
163 <MemberType>Method</MemberType>
165 <ReturnType>System.Boolean</ReturnType>
168 <Parameter Name="dataGridViewCell" Type="System.Windows.Forms.DataGridViewCell" />
171 <remarks>To be added.</remarks>
172 <since version=".NET 2.0" />
174 <attribution license="cc4" from="Microsoft" modified="false" />
175 <para>Determines whether the specified cell is contained in the collection.</para>
178 <attribution license="cc4" from="Microsoft" modified="false" />
179 <para>true if <paramref name="dataGridViewCell" /> is in the collection; otherwise, false.</para>
181 <param name="dataGridViewCell">
182 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DataGridViewCell" /> to locate in the collection.</param>
185 <AssemblyVersion>2.0.0.0</AssemblyVersion>
188 <Member MemberName="CopyTo">
189 <MemberSignature Language="C#" Value="public void CopyTo (System.Windows.Forms.DataGridViewCell[] array, int index);" />
190 <MemberType>Method</MemberType>
192 <ReturnType>System.Void</ReturnType>
195 <Parameter Name="array" Type="System.Windows.Forms.DataGridViewCell[]" />
196 <Parameter Name="index" Type="System.Int32" />
199 <remarks>To be added.</remarks>
200 <since version=".NET 2.0" />
202 <attribution license="cc4" from="Microsoft" modified="false" />
203 <para>Copies the entire collection of cells into an array at a specified location within the array.</para>
206 <attribution license="cc4" from="Microsoft" modified="false" />The destination array to which the contents will be copied.</param>
208 <attribution license="cc4" from="Microsoft" modified="false" />The index of the element in <paramref name="array" /> at which to start copying.</param>
211 <AssemblyVersion>2.0.0.0</AssemblyVersion>
214 <Member MemberName="IndexOf">
215 <MemberSignature Language="C#" Value="public int IndexOf (System.Windows.Forms.DataGridViewCell dataGridViewCell);" />
216 <MemberType>Method</MemberType>
218 <ReturnType>System.Int32</ReturnType>
221 <Parameter Name="dataGridViewCell" Type="System.Windows.Forms.DataGridViewCell" />
224 <remarks>To be added.</remarks>
225 <since version=".NET 2.0" />
227 <attribution license="cc4" from="Microsoft" modified="false" />
228 <para>Returns the index of the specified cell.</para>
231 <attribution license="cc4" from="Microsoft" modified="false" />
232 <para>The zero-based index of the value of <paramref name="dataGridViewCell" /> parameter, if it is found in the collection; otherwise, -1.</para>
234 <param name="dataGridViewCell">
235 <attribution license="cc4" from="Microsoft" modified="false" />The cell to locate in the collection.</param>
238 <AssemblyVersion>2.0.0.0</AssemblyVersion>
241 <Member MemberName="Insert">
242 <MemberSignature Language="C#" Value="public virtual void Insert (int index, System.Windows.Forms.DataGridViewCell dataGridViewCell);" />
243 <MemberType>Method</MemberType>
245 <ReturnType>System.Void</ReturnType>
248 <Parameter Name="index" Type="System.Int32" />
249 <Parameter Name="dataGridViewCell" Type="System.Windows.Forms.DataGridViewCell" />
252 <since version=".NET 2.0" />
254 <attribution license="cc4" from="Microsoft" modified="false" />
255 <para>Use this method to alter the collection before you add the containing row to a <see cref="T:System.Windows.Forms.DataGridView" /> control. Once you add the row to a control, the number of cells it contains always matches the number of columns in the control, so this method is no longer useful. </para>
258 <attribution license="cc4" from="Microsoft" modified="false" />
259 <para>Inserts a cell into the collection at the specified index. </para>
262 <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index at which to place <paramref name="dataGridViewCell" />.</param>
263 <param name="dataGridViewCell">
264 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.DataGridViewCell" /> to insert.</param>
267 <AssemblyVersion>2.0.0.0</AssemblyVersion>
270 <Member MemberName="Item">
271 <MemberSignature Language="C#" Value="public System.Windows.Forms.DataGridViewCell this[int index] { set; get; }" />
272 <MemberType>Property</MemberType>
274 <ReturnType>System.Windows.Forms.DataGridViewCell</ReturnType>
277 <Parameter Name="index" Type="System.Int32" />
280 <param name="index">To be added.</param>
281 <summary>To be added.</summary>
282 <value>To be added.</value>
283 <remarks>To be added.</remarks>
284 <since version=".NET 2.0" />
287 <AssemblyVersion>2.0.0.0</AssemblyVersion>
290 <Member MemberName="Item">
291 <MemberSignature Language="C#" Value="public System.Windows.Forms.DataGridViewCell this[string columnName] { set; get; }" />
292 <MemberType>Property</MemberType>
294 <ReturnType>System.Windows.Forms.DataGridViewCell</ReturnType>
297 <Parameter Name="columnName" Type="System.String" />
300 <param name="columnName">To be added.</param>
301 <summary>To be added.</summary>
302 <value>To be added.</value>
303 <remarks>To be added.</remarks>
304 <since version=".NET 2.0" />
307 <AssemblyVersion>2.0.0.0</AssemblyVersion>
310 <Member MemberName="List">
311 <MemberSignature Language="C#" Value="protected override System.Collections.ArrayList List { get; }" />
312 <MemberType>Property</MemberType>
314 <ReturnType>System.Collections.ArrayList</ReturnType>
317 <value>To be added.</value>
318 <remarks>To be added.</remarks>
319 <since version=".NET 2.0" />
321 <attribution license="cc4" from="Microsoft" modified="false" />
322 <para>Gets an <see cref="T:System.Collections.ArrayList" /> containing <see cref="T:System.Windows.Forms.DataGridViewCellCollection" /> objects.</para>
326 <AssemblyVersion>2.0.0.0</AssemblyVersion>
329 <Member MemberName="OnCollectionChanged">
330 <MemberSignature Language="C#" Value="protected void OnCollectionChanged (System.ComponentModel.CollectionChangeEventArgs e);" />
331 <MemberType>Method</MemberType>
333 <ReturnType>System.Void</ReturnType>
336 <Parameter Name="e" Type="System.ComponentModel.CollectionChangeEventArgs" />
339 <since version=".NET 2.0" />
341 <attribution license="cc4" from="Microsoft" modified="false" />
342 <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>
343 <para>The <see cref="M:System.Windows.Forms.DataGridViewCellCollection.OnCollectionChanged(System.ComponentModel.CollectionChangeEventArgs)" /> 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>
346 <attribution license="cc4" from="Microsoft" modified="false" />
347 <para>Raises the <see cref="E:System.Windows.Forms.DataGridViewCellCollection.CollectionChanged" /> event.</para>
350 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.ComponentModel.CollectionChangeEventArgs" /> that contains the event data. </param>
353 <AssemblyVersion>2.0.0.0</AssemblyVersion>
356 <Member MemberName="Remove">
357 <MemberSignature Language="C#" Value="public virtual void Remove (System.Windows.Forms.DataGridViewCell cell);" />
358 <MemberType>Method</MemberType>
360 <ReturnType>System.Void</ReturnType>
363 <Parameter Name="cell" Type="System.Windows.Forms.DataGridViewCell" />
366 <since version=".NET 2.0" />
368 <attribution license="cc4" from="Microsoft" modified="false" />
369 <para>Use this method to alter the collection before you add the containing row to a <see cref="T:System.Windows.Forms.DataGridView" /> control. Once you add the row to a control, the number of cells it contains always matches the number of columns in the control, so this method is no longer useful. </para>
372 <attribution license="cc4" from="Microsoft" modified="false" />
373 <para>Removes the specified cell from the collection.</para>
376 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.DataGridViewCell" /> to remove from the collection.</param>
379 <AssemblyVersion>2.0.0.0</AssemblyVersion>
382 <Member MemberName="RemoveAt">
383 <MemberSignature Language="C#" Value="public virtual void RemoveAt (int index);" />
384 <MemberType>Method</MemberType>
386 <ReturnType>System.Void</ReturnType>
389 <Parameter Name="index" Type="System.Int32" />
392 <since version=".NET 2.0" />
394 <attribution license="cc4" from="Microsoft" modified="false" />
395 <para>Use this method to alter the collection before you add the containing row to a <see cref="T:System.Windows.Forms.DataGridView" /> control. Once you add the row to a control, the number of cells it contains always matches the number of columns in the control, so this method is no longer useful. </para>
398 <attribution license="cc4" from="Microsoft" modified="false" />
399 <para>Removes the cell at the specified index.</para>
402 <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index of the <see cref="T:System.Windows.Forms.DataGridViewCell" /> to be removed.</param>
405 <AssemblyVersion>2.0.0.0</AssemblyVersion>
408 <Member MemberName="System.Collections.IList.Add">
409 <MemberSignature Language="C#" Value="int IList.Add (object value);" />
410 <MemberType>Method</MemberType>
412 <AssemblyVersion>2.0.0.0</AssemblyVersion>
415 <ReturnType>System.Int32</ReturnType>
418 <Parameter Name="value" Type="System.Object" />
422 <attribution license="cc4" from="Microsoft" modified="false" />
423 <para>Once you add the row to a control, the number of cells it contains always matches the number of columns in the control, so this method is no longer useful. </para>
424 <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
427 <attribution license="cc4" from="Microsoft" modified="false" />
428 <para>Adds an item to the collection.</para>
431 <attribution license="cc4" from="Microsoft" modified="false" />
432 <para>The position into which the new element was inserted.</para>
435 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.DataGridViewCell" /> to add to the collection.</param>
438 <Member MemberName="System.Collections.IList.Contains">
439 <MemberSignature Language="C#" Value="bool IList.Contains (object value);" />
440 <MemberType>Method</MemberType>
442 <AssemblyVersion>2.0.0.0</AssemblyVersion>
445 <ReturnType>System.Boolean</ReturnType>
448 <Parameter Name="value" Type="System.Object" />
452 <attribution license="cc4" from="Microsoft" modified="false" />
453 <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
456 <attribution license="cc4" from="Microsoft" modified="false" />
457 <para>Determines whether the collection contains the specified value.</para>
460 <attribution license="cc4" from="Microsoft" modified="false" />
461 <para>true if the <paramref name="value" /> is found in the <see cref="T:System.Windows.Forms.DataGridViewCellCollection" />; otherwise, false.</para>
464 <attribution license="cc4" from="Microsoft" modified="false" />The object to locate in the <see cref="T:System.Windows.Forms.DataGridViewCellCollection" />.</param>
467 <Member MemberName="System.Collections.IList.IndexOf">
468 <MemberSignature Language="C#" Value="int IList.IndexOf (object value);" />
469 <MemberType>Method</MemberType>
471 <AssemblyVersion>2.0.0.0</AssemblyVersion>
474 <ReturnType>System.Int32</ReturnType>
477 <Parameter Name="value" Type="System.Object" />
481 <attribution license="cc4" from="Microsoft" modified="false" />
482 <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
485 <attribution license="cc4" from="Microsoft" modified="false" />
486 <para>Determines the index of a specific item in a collection.</para>
489 <attribution license="cc4" from="Microsoft" modified="false" />
490 <para>The index of value if found in the list; otherwise, -1.</para>
493 <attribution license="cc4" from="Microsoft" modified="false" />The object to locate in the <see cref="T:System.Windows.Forms.DataGridViewCellCollection" />.</param>
496 <Member MemberName="System.Collections.IList.Insert">
497 <MemberSignature Language="C#" Value="void IList.Insert (int index, object value);" />
498 <MemberType>Method</MemberType>
500 <AssemblyVersion>2.0.0.0</AssemblyVersion>
503 <ReturnType>System.Void</ReturnType>
506 <Parameter Name="index" Type="System.Int32" />
507 <Parameter Name="value" Type="System.Object" />
511 <attribution license="cc4" from="Microsoft" modified="false" />
512 <para>Once you add the row to a control, the number of cells it contains always matches the number of columns in the control, so this method is no longer useful. </para>
513 <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
516 <attribution license="cc4" from="Microsoft" modified="false" />
517 <para>Inserts an item into the collection at the specified position.</para>
520 <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index at which value should be inserted. </param>
522 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.DataGridViewCell" /> to insert into the <see cref="M:System.Windows.Forms.DataGridViewCellCollection.System#Collections#IList#Insert(System.Int32,System.Object)" />.</param>
525 <Member MemberName="System.Collections.IList.IsFixedSize">
526 <MemberSignature Language="C#" Value="bool System.Collections.IList.IsFixedSize { get; }" />
527 <MemberType>Property</MemberType>
529 <AssemblyVersion>2.0.0.0</AssemblyVersion>
532 <ReturnType>System.Boolean</ReturnType>
535 <value>To be added.</value>
537 <attribution license="cc4" from="Microsoft" modified="false" />
538 <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
541 <attribution license="cc4" from="Microsoft" modified="false" />
542 <para>Gets a value indicating whether the collection has a fixed size.</para>
546 <Member MemberName="System.Collections.IList.Item">
547 <MemberSignature Language="C#" Value="object System.Collections.IList.Item[int index] { set; get; }" />
548 <MemberType>Property</MemberType>
550 <AssemblyVersion>2.0.0.0</AssemblyVersion>
553 <ReturnType>System.Object</ReturnType>
556 <Parameter Name="index" Type="System.Int32" />
559 <param name="index">To be added.</param>
560 <summary>To be added.</summary>
561 <value>To be added.</value>
562 <remarks>To be added.</remarks>
565 <Member MemberName="System.Collections.IList.Remove">
566 <MemberSignature Language="C#" Value="void IList.Remove (object value);" />
567 <MemberType>Method</MemberType>
569 <AssemblyVersion>2.0.0.0</AssemblyVersion>
572 <ReturnType>System.Void</ReturnType>
575 <Parameter Name="value" Type="System.Object" />
579 <attribution license="cc4" from="Microsoft" modified="false" />
580 <para>Once you add the row to a control, the number of cells it contains always matches the number of columns in the control, so this method is no longer useful. </para>
581 <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Windows.Forms.DataGridViewCellCollection" /> instance is cast to an <see cref="T:System.Collections.IList" /> interface.</para>
584 <attribution license="cc4" from="Microsoft" modified="false" />
585 <para>Removes the first occurrence of a specific object from the collection.</para>
588 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.DataGridViewCell" /> to remove from the collection.</param>