GridView.RowClick Event

Allows you to respond to row clicks. The event will not fire when data editing is enabled and the ColumnViewOptionsBehavior.EditorShowMode property is set to MouseDown (and to Default, if multiple row selection is disabled).

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v24.2.dll

Declaration

C#

[DXCategory("Action")]
public event RowClickEventHandler RowClick

VB.NET

<DXCategory("Action")>
Public Event RowClick As RowClickEventHandler

Event Data

The RowClick event's data class is RowClickEventArgs. The following properties provide information specific to this event:

Property	Description
Button	Gets which mouse button was pressed. Inherited from MouseEventArgs.
Clicks	Gets the number of times the mouse button was pressed and released. Inherited from MouseEventArgs.
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.
Handled	Gets or sets whether this event should be forwarded to the control’s parent container. Inherited from HandledMouseEventArgs.
HitInfo	Gets an object that identifies the clicked element.
IsHMouseWheel	This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from DXMouseEventArgs.
IsMouseEvent	Gets whether these event arguments provide data for the MouseUp, MouseDown, and MouseMove events. Inherited from DXMouseEventArgs.
Location	Gets the location of the mouse during the generating mouse event. Inherited from MouseEventArgs.
RowHandle	Gets the handle of the clicked row.
X	Gets the x-coordinate of the mouse during the generating mouse event. Inherited from MouseEventArgs.
Y	Gets the y-coordinate of the mouse during the generating mouse event. Inherited from MouseEventArgs.

The event data class exposes the following methods:

Method	Description
GetMouseArgs(Control, EventArgs)	Converts the MouseEventArgs object passed as a parameter to a DXMouseEventArgs object. Inherited from DXMouseEventArgs.
GetMouseArgs(MouseEventArgs)	Converts the MouseEventArgs object passed as a parameter to a DXMouseEventArgs object. Inherited from DXMouseEventArgs.
Sync()	For internal use. Inherited from DXMouseEventArgs.

Remarks

The RowClick event fires when clicking on any element of a grid row (cell, cell border, row indicator, etc).

The RowClick event will not fire when clicking on a row cell if data editing is enabled and the ColumnViewOptionsBehavior.EditorShowMode property is set to MouseDown (and to Default, if multiple row selection is disabled).

The code sample below illustrates how to use the RowClick event to copy a column’s value into a TextEdit control.

C#

gridView1.Columns["ID"].View.OptionsBehavior.EditorShowMode = EditorShowMode.MouseUp;
gridView1.RowClick += gridView1_RowClick;

private void gridView1_RowClick(object sender, DevExpress.XtraGrid.Views.Grid.RowClickEventArgs e)
{
    textEdit1.EditValue = (sender as GridView).GetFocusedRowCellValue("ID");
}

VB.NET

Private gridView1.Columns("ID").View.OptionsBehavior.EditorShowMode = EditorShowMode.MouseUp
Private gridView1.RowClick += AddressOf gridView1_RowClick

Private Sub gridView1_RowClick(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.RowClickEventArgs)
            textEdit1.EditValue = (TryCast(sender, GridView)).GetFocusedRowCellValue("ID")
End Sub