DataGridViewRowCollection.Add Method (DataGridViewRow)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Adds the specified DataGridViewRow to the collection.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public virtual int Add(
	DataGridViewRow dataGridViewRow
)

Parameters

dataGridViewRow
Type: System.Windows.Forms.DataGridViewRow

The DataGridViewRow to add to the DataGridViewRowCollection.

Return Value

Type: System.Int32

The index of the new DataGridViewRow.

Exception Condition
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:

-or-

The DataSource property of the DataGridView is not null.

-or-

The DataGridView has no columns.

-or-

The DataGridView property of the dataGridViewRow is not null.

-or-

dataGridViewRow has a Selected property value of true.

-or-

This operation would add a frozen row after unfrozen rows.

ArgumentNullException

dataGridViewRow is null.

ArgumentException

dataGridViewRow has more cells than there are columns in the control.

The Add(DataGridViewRow) method adds a shared row to the DataGridViewRowCollection, if possible. Otherwise, the new row is unshared. For more information, see Best Practices for Scaling the Windows Forms DataGridView Control.

Rows in the control are not automatically sorted when new rows are added. To sort new rows into their correct position, call the DataGridView.Sort method in a DataGridView.RowsAdded event handler. You might also want to call the DataGridView.Sort method in a CellValueChanged event handler to sort the rows when the user modifies a cell.

.NET Framework
Available since 2.0
Return to top
Show: