ShortcutItemClickEventArgs.Cancel Property

Gets or sets whether to stop processing a pressed shortcut and so stop the bar item’s functionality from being invoked.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v19.2.dll

Declaration

C#

public bool Cancel { get; set; }

VB.NET

Public Property Cancel As Boolean

Property Value

Type	Description
Boolean	true, if processing of the shortcut should be canceled; otherwise, false.

Remarks

Set the Cancel parameter to true to cancel processing of a shortcut and therefore prevent the item’s functionality from being invoked. This can be useful, for instance, if the shortcut should be directed to the currently focused control and not intercepted by the BarManager.

Otherwise, the Bar Manager will invoke the item’s functionality and the currently focused control on your form will not receive key presses.

See the BarManager.ShortcutItemClick event for more information.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Cancel property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-change-the-shortcut-key-assigned-to-a-command-e2857/CS/CommandShortcutChange/Form1.cs#L40

{
    e.Cancel = !(FindForm().ActiveControl == richEditControl2);
}

VB.NET

how-to-change-the-shortcut-key-assigned-to-a-command-e2857/VB/CommandShortcutChange/Form1.vb#L38

Private Sub barManager1_ShortcutItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ShortcutItemClickEventArgs) Handles barManager1.ShortcutItemClick
    e.Cancel = Not(FindForm().ActiveControl Is richEditControl2)
End Sub