Skip to main content
All docs
V24.1

ASPxClientGridBase.KeyPress Event

Occurs when a user presses and releases a key while the control has focus.

Declaration

KeyPress: ASPxClientEvent<ASPxClientGridKeyboardEventHandler<ASPxClientGridBase>>

Event Data

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

Property Description
handled Specifies whether to suppress the keyboard key’s default action. Inherited from ASPxClientGridKeyboardEventArgsBase.
htmlEvent Gets a DHTML event object that relates to the processed event. Inherited from ASPxClientGridKeyboardEventArgsBase.
isAltPressed Specifies whether a user presses the Alt key when the event occurs. Inherited from ASPxClientGridKeyboardEventArgsBase.
isCtrlPressed Specifies whether a user presses the Ctrl key when the event occurs. Inherited from ASPxClientGridKeyboardEventArgsBase.
isShiftPressed Specifies whether a user presses the Shift key when the event occurs. Inherited from ASPxClientGridKeyboardEventArgsBase.
keyCode Gets a key code. Inherited from ASPxClientGridKeyboardEventArgsBase.

Remarks

Handle the KeyPress event to process specific keystrokes. To get information on the pressed key (for instance, its key or code value), use the e.htmlEvent property. You can also use the e.keyCode event property to get the key code as an integer value.

In the example below, ASPxGridView expands all group rows when a user presses the Enter key.

var enterKeyCode = 13;

function onKeyPress(s, e) {       
    if (e.keyCode == enterKeyCode) {
        s.ExpandAll()
    }
}
<dx:ASPxGridView ID="grid" runat="server" ...>
    <Settings ShowGroupPanel="true" />
    <ClientSideEvents KeyPress="onKeyPress" />
    <Columns>
        <dx:GridViewDataColumn FieldName="ShipName" />
        <!--...-->
    </Columns>
</dx:ASPxGridView>
See Also