CoreWebView2AcceleratorKeyPressedEventArgs.IsBrowserAcceleratorKeyEnabled Property

  • Reference

Definition

Namespace:
Microsoft.Web.WebView2.Core
Assembly:
Microsoft.Web.WebView2.Core.dll
Package:
Microsoft.Web.WebView2 v1.0.2210.55
Package:
Microsoft.Web.WebView2 v1.0.2277.86
Package:
Microsoft.Web.WebView2 v1.0.2357-prerelease
Package:
Microsoft.Web.WebView2 v1.0.2365.46
Package:
Microsoft.Web.WebView2 v1.0.2415-prerelease
Package:
Microsoft.Web.WebView2 v1.0.2420.47
Package:
Microsoft.Web.WebView2 v1.0.2470-prerelease
Package:
Microsoft.Web.WebView2 v1.0.2478.35
Package:
Microsoft.Web.WebView2 v1.0.2526-prerelease

This IsBrowserAcceleratorKeyEnabled property allows developers to control whether the browser handles accelerator keys such as Ctrl+P or F3, etc.

public bool IsBrowserAcceleratorKeyEnabled { get; set; }
member this.IsBrowserAcceleratorKeyEnabled : bool with get, set
Public Property IsBrowserAcceleratorKeyEnabled As Boolean

Property Value

Boolean

Remarks

The `CoreWebView2Settings.AreBrowserAcceleratorKeysEnabled` API is a convenient setting for developers to disable all the browser accelerator keys together. This setting also sets the default value for the `IsBrowserAcceleratorKeyEnabled` property.

By default, `CoreWebView2Settings.AreBrowserAcceleratorKeysEnabled` is `TRUE` and `IsBrowserAcceleratorKeyEnabled` is `TRUE`. When developers change `CoreWebView2Settings.AreBrowserAcceleratorKeysEnabled` setting to `FALSE`, this will change default value for `IsBrowserAcceleratorKeyEnabled` to `FALSE`. If developers want specific keys to be handled by the browser after changing the `CoreWebView2Settings.AreBrowserAcceleratorKeysEnabled` setting to `FALSE`, they need to enable these keys by setting `IsBrowserAcceleratorKeyEnabled` to `TRUE`.

The `CoreWebView2Controller.AcceleratorKeyPressed` event is raised any time an accelerator key is pressed, regardless of whether accelerator keys are enabled or not.

This API will give the event arg higher priority over the `CoreWebView2Settings.AreBrowserAcceleratorKeysEnabled` setting when we handle the keys.

With `IsBrowserAcceleratorKeyEnabled` property, if developers mark `IsBrowserAcceleratorKeyEnabled` as `FALSE`, the browser will skip the WebView2 browser feature accelerator key handling process, but the event propagation continues, and web content will receive the key combination.

This property does not disable accelerator keys related to movement and text editing, such as: - Home, End, Page Up, and Page Down - Ctrl-X, Ctrl-C, Ctrl-V - Ctrl-A for Select All - Ctrl-Z for Undo

Applies to