-
Notifications
You must be signed in to change notification settings - Fork 55
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add UnhandledKeyPressed.md #3859
Open
zhuhaichao518
wants to merge
12
commits into
api-UnhandledKeyPressed
Choose a base branch
from
api-UnhandledKeyPressed-draft
base: api-UnhandledKeyPressed
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+251
−0
Open
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
f57cfab
Add UnhandledKeyPressed.md
zhuhaichao518 510f895
fix typo
zhuhaichao518 7cbe551
reorganize
zhuhaichao518 4536ed6
fix typo
zhuhaichao518 f2131a3
fix typo
zhuhaichao518 5ebd587
add ref
zhuhaichao518 fa80d92
fix typo
zhuhaichao518 4014578
fix typo
zhuhaichao518 a35bc78
resolve comments
zhuhaichao518 8a6f2f0
Update specs/UnhandledKeyPressed.md
zhuhaichao518 edc9e4b
Update specs/UnhandledKeyPressed.md
zhuhaichao518 cf1683b
formatting UnhandledKeyPressed.md
zhuhaichao518 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
fix typo
commit f2131a32163ec637fb0251627597c3b33792c743
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,8 +3,9 @@ | |
Consumers of the old [WebBrowser](https://learn.microsoft.com/en-us/dotnet/api/system.windows.controls.webbrowser?view=windowsdesktop-7.0) control that relied on the [OnKeyDown](https://learn.microsoft.com/previous-versions/aa752133(v=vs.85)) API that allowed them to receive and handle key events not handled by the browser, [requested](https://github.com/MicrosoftEdge/WebViewFeedback/issues/468) same ability in WebView2. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The OnKeyDown links to IWebBrowser2::Navigate. Is it supposed to link to an OnKeyDown page? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. My mistake. Fixed it. |
||
|
||
# Description | ||
The `UnhandledKeyPressed` event allows developers to subscribe event handlers | ||
to be run when a key event is not handled by the browser (including DOM and browser accelerators). It can be triggered by all keys, which is different from [AcceleratorKeyPressed](https://learn.microsoft.com/en-us/dotnet/api/microsoft.web.webview2.core.corewebview2acceleratorkeypressedeventargs?view=webview2-dotnet-1.0.705.50) event. | ||
The `UnhandledKeyPressed` event allows developers to subscribe event handlers to be run when a key event is not handled by the browser (including DOM and browser accelerators). | ||
|
||
`UnhandledKeyPressed` event can be triggered by all keys, which is different from [AcceleratorKeyPressed](https://learn.microsoft.com/en-us/dotnet/api/microsoft.web.webview2.core.corewebview2acceleratorkeypressedeventargs?view=webview2-dotnet-1.0.705.50) event. | ||
|
||
`UnhandledKeyPressed` event is async, which means 'GetKeyStates' does not return the exact key state when the key event is fired. Use `UnhandledKeyPressedEventArgs.Modifiers` instead to verify whether Ctrl or Alt is down in this situation. | ||
|
||
|
@@ -83,6 +84,8 @@ void CoreWebView2Controller_UnhandledKeyPressed(object sender, CoreWebView2Unhan | |
``` | ||
|
||
# API Details | ||
|
||
## Win32 C++ | ||
```idl | ||
[uuid(053b9a5d-7033-4515-9898-912977d2fde8), object, pointer_default(unique)] | ||
interface ICoreWebView2Controller : IUnknown { | ||
|
@@ -191,6 +194,7 @@ typedef enum COREWEBVIEW2_KEY_PRESSED_FLAG_KIND { | |
} COREWEBVIEW2_KEY_PRESSED_FLAG_KIND; | ||
``` | ||
|
||
## .NET and WinRT | ||
```c# | ||
namespace Microsoft.Web.WebView2.Core | ||
{ | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please limit line lengths to 80 or 100 characters.