This documentation is archived and is not being maintained.

DataGridViewRowsAddedEventArgs Class

Provides data for the RowsAdded event.

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

'Declaration
Public Class DataGridViewRowsAddedEventArgs _
	Inherits EventArgs
'Usage
Dim instance As DataGridViewRowsAddedEventArgs

The RowsAdded event occurs when rows are added to a DataGridView control. When the user adds a new row using the row for new records, the RowIndex value in the handler for this event is equal to the index of the new location of the row for new records, which is one greater than the row just added. When you add rows programmatically, however, the RowIndex value is the index of the first row added.

For more information about handling events, see Consuming Events.

The following code example handles the RowsAdded event to increment the number of rows in a virtual DataGridView. The number of rows is used in the CellValueNeeded handler so it knows when to show a blank cell versus an initialized cell for a new row. This example is part of a larger example available in the VirtualMode reference topic.

    Dim newRowNeeded As Boolean 

    Private Sub dataGridView1_NewRowNeeded(ByVal sender As Object, _
        ByVal e As DataGridViewRowEventArgs) _
        Handles dataGridView1.NewRowNeeded

        newRowNeeded = True 
    End Sub 

    Const initialSize As Integer = 5000000
    Dim numberOfRows As Integer = initialSize

    Private Sub dataGridView1_RowsAdded(ByVal sender As Object, _
        ByVal e As DataGridViewRowsAddedEventArgs) _
        Handles dataGridView1.RowsAdded

        If newRowNeeded Then
            newRowNeeded = False
            numberOfRows = numberOfRows + 1
        End If 
    End Sub

#Region "data store maintance" 
    Const initialValue As Integer = -1

    Private Sub dataGridView1_CellValueNeeded(ByVal sender As Object, _
        ByVal e As DataGridViewCellValueEventArgs) _
        Handles dataGridView1.CellValueNeeded

        If store.ContainsKey(e.RowIndex) Then 
            ' Use the store if the e value has been modified  
            ' and stored.
            e.Value = store(e.RowIndex)
        ElseIf newRowNeeded AndAlso e.RowIndex = numberOfRows Then 
            If dataGridView1.IsCurrentCellInEditMode Then
                e.Value = initialValue
            Else 
                ' Show a blank value if the cursor is just resting 
                ' on the last row.
                e.Value = String.Empty
            End If 
        Else
            e.Value = e.RowIndex
        End If 
    End Sub 

    Private Sub dataGridView1_CellValuePushed(ByVal sender As Object, _
        ByVal e As DataGridViewCellValueEventArgs) _
        Handles dataGridView1.CellValuePushed

        store.Add(e.RowIndex, CInt(e.Value))

    End Sub
#End Region

    Dim store As System.Collections.Generic.Dictionary(Of Integer, Integer) = _
        New Dictionary(Of Integer, Integer)

System.Object
  System.EventArgs
    System.Windows.Forms.DataGridViewRowsAddedEventArgs

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: