Export (0) Print
Expand All

DataGridViewCellMouseEventArgs Class

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

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

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

public class DataGridViewCellMouseEventArgs : MouseEventArgs

The DataGridViewCellMouseEventArgs type exposes the following members.

  NameDescription
Public methodDataGridViewCellMouseEventArgsInitializes a new instance of the DataGridViewCellMouseEventArgs class.
Top

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

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

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.
Show:
© 2014 Microsoft