DataGridViewRowCollection

Wisej.Web.DataGridViewRowCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

A collection of DataGridViewRow objects.

C#

public class DataGridViewRowCollection : IList, ICollection, IEnumerable, IList<DataGridViewRow>, ICollection<DataGridViewRow>, IEnumerable<DataGridViewRow>

VB.NET

Public Class DataGridViewRowCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of DataGridViewRow), ICollection(Of DataGridViewRow), IEnumerable(Of DataGridViewRow)

Constructors

DataGridViewRowCollection(dataGrid)

Initializes a new instance of the DataGridViewRowCollection class for the given DataGridView.

Name	Type	Description
dataGrid	DataGridView	The DataGridView that created this collection.

Properties

Count

Int32: Returns the number of rows in the collection.

Item(index)

DataGridViewRow: Returns the DataGridViewRow at the specified index.

Throws:

• ArgumentOutOfRangeException index is less than 0.- or - index is equal to or greater than Count.

Methods

Add()

Adds a new DataGridViewRow to the collection.

Returns: Int32. The index of the new DataGridViewRow.

Throws:

• ArgumentException The row returned by the RowTemplate property has more cells than there are columns in the control.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null. Or the DataGridView has no columns.

Add(values)

Adds a new DataGridViewRow to the collection, and populates the cells with the specified objects.

Parameter	Type	Description
values	Object[]	A variable number of objects that populate the cells of the new DataGridViewRow.

Returns: Int32. The index of the new DataGridViewRow.

Throws:

• ArgumentNullException values is null.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null. Or the DataGridView has no columns. Or the VirtualMode property of the DataGridView is set to true. Or the row returned by the RowTemplate property has more cells than there are columns in the control.

Add(row)

Adds the specified DataGridViewRow to the collection.

Parameter	Type	Description
row	DataGridViewRow	The DataGridViewRow to add to the DataGridViewRowCollection.

Returns: Int32. The index of the new DataGridViewRow.

Throws:

• ArgumentNullException row is null.

• ArgumentException row has more cells than there are columns in the control.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null. Or the DataGridView has no columns.

Add(count)

Adds the specified number of new rows to the collection.

Parameter	Type	Description
count	Int32	The number of rows to add to the DataGridViewRowCollection.

Returns: Int32. The index of the last row that was added.

Throws:

• ArgumentOutOfRangeException count is less than 1.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null. Or the DataGridView has no columns.

AddCopies(rowIndex, count)

Adds the specified number of rows to the collection based on the row at the specified index.

Parameter	Type	Description
rowIndex	Int32	The index of the row on which to base the new rows.
count	Int32	The number of rows to add to the DataGridViewRowCollection.

Returns: Int32. The index of the last row that was added.

Throws:

• ArgumentOutOfRangeException rowIndex is less than zero or greater than or equal to the number of rows in the control; or count is less than zero.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null.

AddCopy(rowIndex)

Adds a DataGridViewRow row based on the DataGridViewRow at the specified index.

Parameter	Type	Description
rowIndex	Int32	The index of the row on which to base the new row.

Returns: Int32. The index of the new DataGridViewRow.

Throws:

• ArgumentOutOfRangeException rowIndex is less than zero or greater than or equal to the number of rows in the collection.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null.

AddRange(newRows)

Adds the specified DataGridViewRow objects to the collection.

Parameter	Type	Description
newRows	DataGridViewRow[]	An array of DataGridViewRow objects to be added to the DataGridViewRowCollection.

Throws:

• ArgumentNullException newRows is null.

• ArgumentException newRows contains only one row, and the row it contains has more cells than there are columns in the control.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null.

Clear()

Clears the collection.

Throws:

• InvalidOperationException The collection is data bound and the underlying data source does not support clearing the row data. Or the associated DataGridView control is performing one of the following actions that temporarily prevents the row collection from being modified: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating

Contains(row)

Determines whether the specified DataGridViewRow is in the collection.

Parameter	Type	Description
row	DataGridViewRow	The DataGridViewRow to locate in the DataGridViewRowCollection.

Returns: Boolean. true if the DataGridViewRow is in the DataGridViewRowCollection; otherwise, false.

CopyTo(array, index)

Copies the items from the collection into the specified DataGridViewRow array, starting at the specified index.

Parameter	Type	Description
array	DataGridViewRow[]	A DataGridViewRow array that is the destination of the items copied from the DataGridViewRowCollection.
index	Int32	The zero-based index in array at which copying begins.

Throws:

• ArgumentNullException array is null.

• ArgumentOutOfRangeException index is less than zero.

• ArgumentException array is multidimensional; or the number of elements in the DataGridViewRowCollection is greater than the available space from index to the end of array .

GetFirstRow(includeFilter, excludeFilter)

Returns the first DataGridViewRow that matches the specified includeFilter and excludeFilter .

Parameter	Type	Description
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.
excludeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: DataGridViewRow. The first DataGridViewRow that matches the specified filters; or null if no row is found.

Throws:

• ArgumentException One or both of the specified filter values is not a valid combination of DataGridViewElementStates values.

GetFirstRowIndex(includeFilter, excludeFilter)

Returns the index of the first DataGridViewRow that matches the specified includeFilter and excludeFilter .

Parameter	Type	Description
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.
excludeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: Int32. The index of the first DataGridViewRow that matches the specified filters; or -1 if no row is found.

Throws:

• ArgumentException One or both of the specified filter values is not a valid combination of DataGridViewElementStates values.

GetLastRow(includeFilter, excludeFilter)

Returns the last DataGridViewRow that matches the includeFilter and excludeFilter .

Parameter	Type	Description
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.
excludeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: DataGridViewRow. The last DataGridViewRow that matches the specified filter; or null if no row is found.

Throws:

• ArgumentException includeFilter is not a valid bitwise combination of DataGridViewElementStates values.

GetLastRowIndex(includeFilter, excludeFilter)

Returns the index of the last DataGridViewRow that matches the includeFilter and excludeFilter .

Parameter	Type	Description
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.
excludeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: Int32. The index of the last DataGridViewRow that matches the specified filter; or -1 if no row is found.

Throws:

• ArgumentException includeFilter is not a valid bitwise combination of DataGridViewElementStates values.

GetNextRow(startRow, includeFilter, excludeFilter)

Returns the next DataGridViewRow after startRow that matches the includeFilter and excludeFilter .

Parameter	Type	Description
startRow	DataGridViewRow	The row where the method should begin to look for the next DataGridViewRow.
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.
excludeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: DataGridViewRow. The next DataGridViewRow that matches the filters; or null if no row is found after startRow .

Throws:

• ArgumentNullException startRow is null.

• ArgumentException One or both of the specified filter values is not a valid bitwise combination of DataGridViewElementStates values.

GetNextRow(startIndex, includeFilter, excludeFilter)

Returns the next DataGridViewRow after startIndex that matches the includeFilter and excludeFilter .

Parameter	Type	Description
startIndex	Int32	The index of the row where the method should begin to look for the next DataGridViewRow.
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.
excludeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: DataGridViewRow. The next DataGridViewRow that matches the filters; or null if no row is found after startIndex .

Throws:

• ArgumentOutOfRangeException startIndex is less than -1.

• ArgumentException One or both of the specified filter values is not a valid bitwise combination of DataGridViewElementStates values.

GetNextRowIndex(startRow, includeFilter, excludeFilter)

Returns the index of the next DataGridViewRow after startRow that matches the includeFilter and excludeFilter .

Parameter	Type	Description
startRow	DataGridViewRow	The row where the method should begin to look for the next DataGridViewRow.
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.
excludeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: Int32. The index of the next DataGridViewRow that matches the filters; or -1 if no row is found after startRow .

Throws:

• ArgumentNullException startRow is null.

• ArgumentException One or both of the specified filter values is not a valid bitwise combination of DataGridViewElementStates values.

GetNextRowIndex(startIndex, includeFilter, excludeFilter)

Returns the index of the next DataGridViewRow after startIndex that matches the includeFilter and excludeFilter .

Parameter	Type	Description
startIndex	Int32	The index of the row where the method should begin to look for the next DataGridViewRow.
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.
excludeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: Int32. The index of the next DataGridViewRow that matches the filters; or -1 if no row is found after startIndex .

Throws:

• ArgumentOutOfRangeException startIndex is less than -1.

• ArgumentException One or both of the specified filter values is not a valid bitwise combination of DataGridViewElementStates values.

GetPreviousRow(startRow, includeFilter, excludeFilter)

Returns the previous DataGridViewRow before startRow that matches the includeFilter and excludeFilter .

Parameter	Type	Description
startRow	DataGridViewRow	The row where the method should begin to look for the previous DataGridViewRow.
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.
excludeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: DataGridViewRow. The previous DataGridViewRow that matches the filters; or null if no row is found before startRow .

Throws:

• ArgumentNullException startRow is null.

• ArgumentException One or both of the specified filter values is not a valid bitwise combination of DataGridViewElementStates values.

GetPreviousRow(startIndex, includeFilter, excludeFilter)

Returns the previous DataGridViewRow before startIndex that matches the includeFilter and excludeFilter .

Parameter	Type	Description
startIndex	Int32	The index of the row where the method should begin to look for the previous DataGridViewRow.
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.
excludeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: DataGridViewRow. The previous DataGridViewRow that matches the filters; or null if no row is found before startIndex .

Throws:

• ArgumentOutOfRangeException startIndex is greater than the number of rows in the collection.

• ArgumentException One or both of the specified filter values is not a valid bitwise combination of DataGridViewElementStates values.

GetPreviousRowIndex(startRow, includeFilter, excludeFilter)

Returns the index of the previous DataGridViewRow before startRow that matches the includeFilter and excludeFilter .

Parameter	Type	Description
startRow	DataGridViewRow	The row where the method should begin to look for the previous DataGridViewRow.
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.
excludeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: Int32. The index of previous DataGridViewRow that matches the filters; or -1 if no row is found before startRow .

Throws:

• ArgumentNullException startRow is null.

• ArgumentException One or both of the specified filter values is not a valid bitwise combination of DataGridViewElementStates values.

GetPreviousRowIndex(startIndex, includeFilter, excludeFilter)

Returns the index of the previous DataGridViewRow before startIndex that matches the includeFilter and excludeFilter .

Parameter	Type	Description
startIndex	Int32	The index of the row where the method should begin to look for the previous DataGridViewRow.
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.
excludeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: Int32. The index of the previous DataGridViewRow that matches the filters; or -1 if no row is found before startIndex .

Throws:

• ArgumentOutOfRangeException startIndex is greater than the number of rows in the collection.

• ArgumentException One or both of the specified filter values is not a valid bitwise combination of DataGridViewElementStates values.

GetRowCount(includeFilter)

Returns the number of rows that match the includeFilter .

Parameter	Type	Description
includeFilter	DataGridViewElementStates	A combination of the DataGridViewElementStates values for inclusion.

Returns: Int32. The number of rows that match the includeFilter .

Throws:

• ArgumentException includeFilter is not a valid bitwise combination of DataGridViewElementStates values.

GetRowsHeight(includeFilter)

Returns the cumulative height of the DataGridViewRow objects that match the includeFilter .

Parameter	Type	Description
includeFilter	DataGridViewElementStates	A bitwise combination of DataGridViewElementStates values.

Returns: Int32. The cumulative height of DataGridViewRow objects that match the includeFilter .

Throws:

• ArgumentException includeFilter is not a valid bitwise combination of DataGridViewElementStates values.

GetRowState(rowIndex)

Returns the state of the DataGridViewRow at the specified index.

Parameter	Type	Description
rowIndex	Int32	The index of the row.

Returns: DataGridViewElementStates. A combination of DataGridViewElementStates values indicating the state of the row.

Throws:

• ArgumentOutOfRangeException rowIndex is less than zero and greater than the number of rows in the collection.

IndexOf(row)

Returns the index of the given DataGridViewRow in the collection.

Parameter	Type	Description
row	DataGridViewRow	The DataGridViewRow to return the index of.

Returns: Int32. The index of the given DataGridViewRow.

Insert(index)

Inserts a DataGridViewRow into the collection at the specified position.

Parameter	Type	Description
index	Int32	The position at which to insert the DataGridViewRow.

Throws:

• ArgumentOutOfRangeException index is less than zero or greater than the number of rows in the collection.

• ArgumentException The row returned by the control's RowTemplate property has more cells than there are columns in the control.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null. Or the DataGridView has no columns. Or the VirtualMode property of the DataGridView is set to true. Or the row returned by the RowTemplate property has more cells than there are columns in the control.

Insert(index, values)

Inserts a DataGridViewRow into the collection at the specified position, and populates the cells with the specified objects.

Parameter	Type	Description
index	Int32	The position at which to insert the DataGridViewRow.
values	Object[]	A variable number of objects that populate the cells of the new DataGridViewRow.

Throws:

• ArgumentOutOfRangeException index is less than zero or greater than the number of rows in the collection.

• ArgumentNullException values is null.

• ArgumentException The row returned by the control's RowTemplate property has more cells than there are columns in the control.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null. Or the DataGridView has no columns. Or the VirtualMode property of the DataGridView is set to true. Or the row returned by the RowTemplate property has more cells than there are columns in the control.

Insert(index, row)

Inserts the specified DataGridViewRow into the collection.

Parameter	Type	Description
index	Int32	The position at which to insert the row.
row	DataGridViewRow	The DataGridViewRow to insert into the DataGridViewRowCollection.

Throws:

• ArgumentOutOfRangeException index is less than zero or greater than the number of rows in the collection.

• ArgumentNullException row is null.

• ArgumentException row has more cells than there are columns in the control.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null. Or the DataGridView has no columns.

Insert(index, count)

Inserts the specified number of rows into the collection at the specified location.

Parameter	Type	Description
index	Int32	The position at which to insert the rows.
count	Int32	The number of rows to insert into the DataGridViewRowCollection.

Throws:

• ArgumentOutOfRangeException index is less than zero or greater than the number of rows in the collection. or count is less than 1.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null. Or the DataGridView has no columns.

InsertCopies(indexSource, indexDestination, count)

Inserts rows into the collection at the specified position.

Parameter	Type	Description
indexSource	Int32	The index of the DataGridViewRow on which to base the new rows.
indexDestination	Int32	The position at which to insert the rows.
count	Int32	The number of DataGridViewRow objects to add to the DataGridViewRowCollection.

Throws:

• ArgumentOutOfRangeException indexSource is less than zero or greater than the number of rows in the collection minus one; or indexDestination is less than zero or greater than the number of rows in the collection; or count is less than 1.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null.

InsertCopy(indexSource, indexDestination)

Inserts a new DataGridViewRow into the collection at the specified indexDestination , based on the DataGridViewRow at indexSource .

Parameter	Type	Description
indexSource	Int32	The index of the DataGridViewRow on which to base the new DataGridViewRow.
indexDestination	Int32	The position at which to insert the row.

Throws:

• ArgumentOutOfRangeException indexSource is less than zero or greater than the number of rows in the collection minus one; or indexDestination is less than zero or greater than the number of rows in the collection.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null.

InsertRange(index, newRows)

Inserts the DataGridViewRow objects into the collection at the specified position.

Parameter	Type	Description
index	Int32	The position at which to insert the rows.
newRows	DataGridViewRow[]	An array of DataGridViewRow objects to add to the DataGridViewRowCollection.

Throws:

• ArgumentNullException newRows is null.

• ArgumentOutOfRangeException index is less than zero or greater than the number of rows in the collection.

• ArgumentException newRows contains only one row, and the row it contains has more cells than there are columns in the control.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null.

Remove(row)

Removes the row from the collection.

Parameter	Type	Description
row	DataGridViewRow	The row to remove from the DataGridViewRowCollection.

Throws:

• ArgumentNullException row is null.

• ArgumentException row is not contained in this collection; or row is a shared row.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null. Or the DataGridView has no columns.

RemoveAt(index)

Removes the DataGridViewRow at the specified position from the collection.

Parameter	Type	Description
index	Int32	The position of the row to remove.

Throws:

• ArgumentOutOfRangeException index is less than zero and greater than the number of rows in the collection minus one.

• InvalidOperationException The associated DataGridView control is performing one of the following actions that temporarily prevents new rows from being added: - Selecting all cells in the control. - Clearing the selection. Or this method is being called from a handler for one of the following DataGridView events: - CellEnter - CellLeave - CellValidating - CellValidated - RowEnter - RowLeave - RowValidated - RowValidating Or the DataSource property of the DataGridView is not null. Or the DataGridView has no columns.

SetRowState(rowIndex, state)

Sets the state for the row at rowIndex .

Parameter	Type	Description
rowIndex	Int32	The index of the row.
state	DataGridViewElementStates	DataGridViewElementStates state to set.

Throws:

• ArgumentOutOfRangeException rowIndex is less than zero and greater than the number of rows in the collection.

Events

CollectionChanged

CollectionChangeEventHandler Fired when the collection changes.