Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

DataGridViewCellMouseEventArgs Class

Provides data for mouse events raised by a DataGridView whenever the mouse is moved within a DataGridViewCell.


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

Public Class DataGridViewCellMouseEventArgs _
	Inherits MouseEventArgs

The DataGridViewCellMouseEventArgs type exposes the following members.

Public methodDataGridViewCellMouseEventArgsInitializes a new instance of the DataGridViewCellMouseEventArgs class.

Public propertyButtonGets which mouse button was pressed. (Inherited from MouseEventArgs.)
Public propertyClicksGets the number of times the mouse button was pressed and released. (Inherited from MouseEventArgs.)
Public propertyColumnIndexGets the zero-based column index of the cell.
Public propertyDeltaGets a signed count of the number of detents the mouse wheel has rotated, multiplied by the WHEEL_DELTA constant. A detent is one notch of the mouse wheel. (Inherited from MouseEventArgs.)
Public propertyLocationGets the location of the mouse during the generating mouse event. (Inherited from MouseEventArgs.)
Public propertyRowIndexGets the zero-based row index of the cell.
Public propertyXGets the x-coordinate of the mouse during the generating mouse event. (Inherited from MouseEventArgs.)
Public propertyYGets the y-coordinate of the mouse during the generating mouse event. (Inherited from MouseEventArgs.)

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

The following code example illustrates the use of this type.

Private Sub dataGridView1_ColumnHeaderMouseClick(ByVal sender As Object, _
    ByVal e As DataGridViewCellMouseEventArgs) _
    Handles dataGridView1.ColumnHeaderMouseClick

    Dim newColumn As DataGridViewColumn = _
    Dim oldColumn As DataGridViewColumn = dataGridView1.SortedColumn
    Dim direction As ListSortDirection

    ' If oldColumn is null, then the DataGridView is not currently sorted. 
    If oldColumn IsNot Nothing Then 

        ' Sort the same column again, reversing the SortOrder. 
        If oldColumn Is newColumn AndAlso dataGridView1.SortOrder = _
            SortOrder.Ascending Then
            direction = ListSortDirection.Descending

            ' Sort a new column and remove the old SortGlyph.
            direction = ListSortDirection.Ascending
            oldColumn.HeaderCell.SortGlyphDirection = SortOrder.None
        End If 
        direction = ListSortDirection.Ascending
    End If 

    ' Sort the selected column.
    dataGridView1.Sort(newColumn, direction)
    If direction = ListSortDirection.Ascending Then
        newColumn.HeaderCell.SortGlyphDirection = SortOrder.Ascending
        newColumn.HeaderCell.SortGlyphDirection = SortOrder.Descending
    End If 

End Sub 

Private Sub dataGridView1_DataBindingComplete(ByVal sender As Object, _
    ByVal e As DataGridViewBindingCompleteEventArgs) _
    Handles dataGridView1.DataBindingComplete

    ' Put each of the columns into programmatic sort mode. 
    For Each column As DataGridViewColumn In dataGridView1.Columns
        column.SortMode = DataGridViewColumnSortMode.Programmatic
End Sub

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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