DataGridViewCellMouseEventArgs DataGridViewCellMouseEventArgs DataGridViewCellMouseEventArgs DataGridViewCellMouseEventArgs Class

Definition

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

public ref class DataGridViewCellMouseEventArgs : System::Windows::Forms::MouseEventArgs
public class DataGridViewCellMouseEventArgs : System.Windows.Forms.MouseEventArgs
type DataGridViewCellMouseEventArgs = class
    inherit MouseEventArgs
Public Class DataGridViewCellMouseEventArgs
Inherits MouseEventArgs
Inheritance
DataGridViewCellMouseEventArgsDataGridViewCellMouseEventArgsDataGridViewCellMouseEventArgsDataGridViewCellMouseEventArgs

Examples

The following code example illustrates the use of this type.

private void dataGridView1_ColumnHeaderMouseClick(
    object sender, DataGridViewCellMouseEventArgs e)
{
    DataGridViewColumn newColumn = dataGridView1.Columns[e.ColumnIndex];
    DataGridViewColumn oldColumn = dataGridView1.SortedColumn;
    ListSortDirection direction;

    // If oldColumn is null, then the DataGridView is not sorted.
    if (oldColumn != null)
    {
        // Sort the same column again, reversing the SortOrder.
        if (oldColumn == newColumn &&
            dataGridView1.SortOrder == SortOrder.Ascending)
        {
            direction = ListSortDirection.Descending;
        }
        else
        {
            // Sort a new column and remove the old SortGlyph.
            direction = ListSortDirection.Ascending;
            oldColumn.HeaderCell.SortGlyphDirection = SortOrder.None;
        }
    }
    else
    {
        direction = ListSortDirection.Ascending;
    }

    // Sort the selected column.
    dataGridView1.Sort(newColumn, direction);
    newColumn.HeaderCell.SortGlyphDirection =
        direction == ListSortDirection.Ascending ?
        SortOrder.Ascending : SortOrder.Descending;
}

private void dataGridView1_DataBindingComplete(object sender,
    DataGridViewBindingCompleteEventArgs e)
{
    // Put each of the columns into programmatic sort mode.
    foreach (DataGridViewColumn column in dataGridView1.Columns)
    {
        column.SortMode = DataGridViewColumnSortMode.Programmatic;
    }
}
Private Sub dataGridView1_ColumnHeaderMouseClick(ByVal sender As Object, _
    ByVal e As DataGridViewCellMouseEventArgs) _
    Handles dataGridView1.ColumnHeaderMouseClick

    Dim newColumn As DataGridViewColumn = _
        dataGridView1.Columns(e.ColumnIndex)
    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
        Else

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

    ' Sort the selected column.
    dataGridView1.Sort(newColumn, direction)
    If direction = ListSortDirection.Ascending Then
        newColumn.HeaderCell.SortGlyphDirection = SortOrder.Ascending
    Else
        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
    Next
End Sub

Remarks

The DataGridViewCellMouseEventArgs class provides data for the following DataGridView events:

Constructors

DataGridViewCellMouseEventArgs(Int32, Int32, Int32, Int32, MouseEventArgs) DataGridViewCellMouseEventArgs(Int32, Int32, Int32, Int32, MouseEventArgs) DataGridViewCellMouseEventArgs(Int32, Int32, Int32, Int32, MouseEventArgs) DataGridViewCellMouseEventArgs(Int32, Int32, Int32, Int32, MouseEventArgs)

Initializes a new instance of the DataGridViewCellMouseEventArgs class.

Properties

Button Button Button Button

Gets which mouse button was pressed.

(Inherited from MouseEventArgs)
Clicks Clicks Clicks Clicks

Gets the number of times the mouse button was pressed and released.

(Inherited from MouseEventArgs)
ColumnIndex ColumnIndex ColumnIndex ColumnIndex

Gets the zero-based column index of the cell.

Delta Delta Delta Delta

Gets 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)
Location Location Location Location

Gets the location of the mouse during the generating mouse event.

(Inherited from MouseEventArgs)
RowIndex RowIndex RowIndex RowIndex

Gets the zero-based row index of the cell.

X X X X

Gets the x-coordinate of the mouse during the generating mouse event.

(Inherited from MouseEventArgs)
Y Y Y Y

Gets the y-coordinate of the mouse during the generating mouse event.

(Inherited from MouseEventArgs)

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also