KeyShortcut Class

A class used by various controls to provide shortcut keys.

Namespace : DevExpress.Utils

Assembly : DevExpress.Utils.v25.2.dll

NuGet Packages : DevExpress.Utils, DevExpress.Wpf.Core

Declaration

• C#
• VB.NET

public class KeyShortcut

Public Class KeyShortcut

Related API Members

The following members return KeyShortcut objects:

• CustomHeaderButton.Shortcut
• EditorButton.Shortcut
• GuideProperties.ShowGuidesShortcut
• ISearchPanelProperties.Shortcut
• RepositoryItemDateTimeOffsetEdit.CloseUpKey
• RepositoryItemHyperLinkEdit.StartKey
• RepositoryItemPopupBase.CloseUpKey
• RepositoryItemTimeEdit.CloseUpKey

Remarks

DevExpress controls provide properties that allow you to provide shortcuts to access functionality. For instance, a popup editor provides the RepositoryItemPopupBase.CloseUpKey property. Pressing this key toggles the visibility of the dropdown window.

To provide a shortcut, create a KeyShortcut object then assign it to the corresponding property. You can create a shortcut based on a Shortcut or Keys enumeration value. Values of the Keys type can be combined using the OR operator.

The shortcut itself can be accessed via the KeyShortcut.Key property.

Example

The following example assigns the Ctrl+Enter shortcut to the RepositoryItemPopupBase.CloseUpKey property. This allows the end-user to press this key combination in order to open and close the dropdown window while accepting the selected value.

• C#
• VB.NET

popupContainerEdit1.Properties.CloseUpKey = new KeyShortcut(Keys.Control | Keys.Enter);

PopupContainerEdit1.Properties.CloseUpKey = New KeyShortcut(Keys.Control Or Keys.Enter)

Inheritance

Object KeyShortcut

See Also

KeyShortcut Members

DevExpress.Utils Namespace