OnKeyDown Method

ListBox.OnKeyDown Method

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Provides handling for the KeyDown event that occurs when a key is pressed while the control has focus.

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

'Declaration
Protected Overrides Sub OnKeyDown ( _
	e As KeyEventArgs _
)

Parameters

e
Type: System.Windows.Input.KeyEventArgs
The event data.

It is not recommended that you rely on this method behavior because typically a soft-interface keyboard is not displayed for a ListBox control and not all devices have a hardware keyboard. The following table lists keys that will cause the KeyDown event to be marked as handled. It also describes how the ListBox handles the key.

Key

Action

Ctrl and Space

If the list item with focus is currently selected, it is deselected. If it is not selected, it is set as the selected item.

Home

Sets the first list item is set as the selected item.

End

Sets the last list item is set as the selected item.

PageUp

Sets the previous list item as the selected item.

PageDown

Sets the next list item as the selected item.

Left

If the ListBox is oriented vertically, scrolls the list to the left. If the ListBox is oriented horizontally, sets the previous item in the list as the selected item.

Up

If the ListBox is oriented horizontally, scrolls the list to the list. If the ListBox is oriented vertically, sets the previous item in the list as the selected item.

Right

If the ListBox is oriented vertically, scrolls the list to the right. If the ListBox is oriented horizontally, sets the next item in the list as the selected item.

Down

If the ListBox is oriented horizontally, scrolls the list down. If the ListBox is oriented vertically, sets the next item in the list as the selected item.

The OnKeyDown method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors

When overriding OnKeyDown in a derived class, be sure to call the base class’s OnKeyDown method so that registered delegates receive the event.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2017 Microsoft