DataGridViewCell.OnMouseClick(DataGridViewCellMouseEventArgs) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Called when the user clicks a mouse button while the pointer is on a cell.

protected:
 virtual void OnMouseClick(System::Windows::Forms::DataGridViewCellMouseEventArgs ^ e);

protected virtual void OnMouseClick (System.Windows.Forms.DataGridViewCellMouseEventArgs e);

abstract member OnMouseClick : System.Windows.Forms.DataGridViewCellMouseEventArgs -> unit
override this.OnMouseClick : System.Windows.Forms.DataGridViewCellMouseEventArgs -> unit

Protected Overridable Sub OnMouseClick (e As DataGridViewCellMouseEventArgs)

Parameters

e: DataGridViewCellMouseEventArgs

A DataGridViewCellMouseEventArgs that contains the event data.

Examples

The following code example demonstrates the use of this method.

// Override OnMouseClick in a class derived from DataGridViewCell to 
// enter edit mode when the user clicks the cell. 
protected override void OnMouseClick(DataGridViewCellMouseEventArgs e)
{
    if (base.DataGridView != null)
    {
        Point point1 = base.DataGridView.CurrentCellAddress;
        if (point1.X == e.ColumnIndex &&
            point1.Y == e.RowIndex &&
            e.Button == MouseButtons.Left &&
            base.DataGridView.EditMode !=
            DataGridViewEditMode.EditProgrammatically)
        {
            base.DataGridView.BeginEdit(true);
        }
    }
}

' Override OnMouseClick in a class derived from DataGridViewCell to 
' enter edit mode when the user clicks the cell. 
Protected Overrides Sub OnMouseClick( _
    ByVal e As DataGridViewCellMouseEventArgs)

    If MyBase.DataGridView IsNot Nothing Then

        Dim point1 As Point = MyBase.DataGridView.CurrentCellAddress
        If point1.X = e.ColumnIndex And _
            point1.Y = e.RowIndex And _
            e.Button = MouseButtons.Left And _
            Not MyBase.DataGridView.EditMode = _
            DataGridViewEditMode.EditProgrammatically Then

            MyBase.DataGridView.BeginEdit(True)

        End If
    End If
End Sub

Remarks

This method is similar to the DataGridView.OnCellMouseClick method. It is called in the same circumstances in which a DataGridView.CellMouseClick event is raised, but it does not actually raise the event.

Applies to

Share via