This topic has not yet been rated - Rate this topic

DataGridViewCellValueEventArgs Class

Provides data for the CellValueNeeded and CellValuePushed events of the DataGridView control.

System.Object
  System.EventArgs
    System.Windows.Forms.DataGridViewCellValueEventArgs

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
'Declaration
Public Class DataGridViewCellValueEventArgs _
	Inherits EventArgs

The DataGridViewCellValueEventArgs type exposes the following members.

  NameDescription
Public methodDataGridViewCellValueEventArgsInitializes a new instance of the DataGridViewCellValueEventArgs class.
Top
  NameDescription
Public propertyColumnIndexGets a value indicating the column index of the cell that the event occurs for.
Public propertyRowIndexGets a value indicating the row index of the cell that the event occurs for.
Public propertyValueGets or sets the value of the cell that the event occurs for.
Top
  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Handle the CellValueNeeded and CellValuePushed events to implement virtual mode in the DataGridView control. For more information about virtual mode, see Virtual Mode in the Windows Forms DataGridView Control.

For more information about handling events, see Consuming Events.

The following code example handles the CellValuePushed event to store updates and new entries in a data store object. This example is part of a larger example available in the DataGridView.VirtualMode reference topic.

#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)

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.