DataGridViewCellMouseEventArgs Class

 
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.

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)

System.Object
  System.EventArgs
    System.Windows.Forms.MouseEventArgs
      System.Windows.Forms.DataGridViewCellMouseEventArgs

public class DataGridViewCellMouseEventArgs : MouseEventArgs

NameDescription
System_CAPS_pubmethodDataGridViewCellMouseEventArgs(Int32, Int32, Int32, Int32, MouseEventArgs)

Initializes a new instance of the DataGridViewCellMouseEventArgs class.

NameDescription
System_CAPS_pubpropertyButton

Gets which mouse button was pressed.(Inherited from MouseEventArgs.)

System_CAPS_pubpropertyClicks

Gets the number of times the mouse button was pressed and released.(Inherited from MouseEventArgs.)

System_CAPS_pubpropertyColumnIndex

Gets the zero-based column index of the cell.

System_CAPS_pubpropertyDelta

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

System_CAPS_pubpropertyLocation

Gets the location of the mouse during the generating mouse event.(Inherited from MouseEventArgs.)

System_CAPS_pubpropertyRowIndex

Gets the zero-based row index of the cell.

System_CAPS_pubpropertyX

Gets the x-coordinate of the mouse during the generating mouse event.(Inherited from MouseEventArgs.)

System_CAPS_pubpropertyY

Gets the y-coordinate of the mouse during the generating mouse event.(Inherited from MouseEventArgs.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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;
    }
}

.NET Framework
Available since 2.0

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

Return to top
Show: