Skip to content

Commit

Permalink
Merge pull request #2896 from mikehoffms/user/mikehoffms/dmc-to-lmc
Browse files Browse the repository at this point in the history
Changed docs.microsoft.com to learn.microsoft.com
  • Loading branch information
peiche-jessica authored Oct 20, 2022
2 parents 240d575 + 4794d2f commit ab8420c
Show file tree
Hide file tree
Showing 17 changed files with 39 additions and 39 deletions.
10 changes: 5 additions & 5 deletions specs/BrowserProcessExited.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ is that `BrowserProcessExited` is raised for any **browser process** exit
`ProcessFailed` is raised for **unexpected** process exits of any kind (browser,
render, GPU, and all other types), or for main frame **render process**
unresponsiveness. To learn more about the WebView2 Process Model, go to
[Process model](https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/process-model).
[Process model](https://learn.microsoft.com/microsoft-edge/webview2/concepts/process-model).

In the case the browser process crashes, both `BrowserProcessExited` and
`ProcessFailed` events are raised, but the order is not guaranteed.
Expand Down Expand Up @@ -318,7 +318,7 @@ interface ICoreWebView2Environment3 : ICoreWebView2Environment2
/// due to browser process failure or normal shutdown (for example, when all
/// associated WebViews are closed), after all resources have been released
/// (including the user data folder). To learn about what these processes are,
/// go to [Process model](https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/process-model).
/// go to [Process model](https://learn.microsoft.com/microsoft-edge/webview2/concepts/process-model).
///
/// A handler added with this method is called until removed with
/// `remove_BrowserProcessExited`, even if a new browser process is bound to
Expand All @@ -344,7 +344,7 @@ interface ICoreWebView2Environment3 : ICoreWebView2Environment2
/// **unexpected** process exits of any kind (browser, render, GPU, and all
/// other types), or for main frame **render process** unresponsiveness. To
/// learn more about the WebView2 Process Model, go to
/// [Process model](https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/process-model).
/// [Process model](https://learn.microsoft.com/microsoft-edge/webview2/concepts/process-model).
///
/// In the case the browser process crashes, both `BrowserProcessExited` and
/// `ProcessFailed` events are raised, but the order is not guaranteed. These
Expand Down Expand Up @@ -408,7 +408,7 @@ namespace Microsoft.Web.WebView2.Core
/// terminate due to browser process failure or normal shutdown (for example,
/// when all associated WebViews are closed), after all resources have been
/// released (including the user data folder). To learn about what these processes
/// are, go to [Process model](https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/process-model).
/// are, go to [Process model](https://learn.microsoft.com/microsoft-edge/webview2/concepts/process-model).
///
/// Multiple app processes can share a browser process by creating their webviews
/// from a `CoreWebView2Environment` with the same user data folder. When the entire
Expand All @@ -429,7 +429,7 @@ namespace Microsoft.Web.WebView2.Core
/// `ProcessFailed` is raised for **unexpected** process exits of any kind (browser,
/// render, GPU, and all other types), or for main frame **render process**
/// unresponsiveness. To learn more about the WebView2
/// Process Model, go to [Process model](https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/process-model).
/// Process Model, go to [Process model](https://learn.microsoft.com/microsoft-edge/webview2/concepts/process-model).
///
/// In the case the browser process crashes, both `BrowserProcessExited` and
/// `ProcessFailed` events are raised, but the order is not guaranteed. These
Expand Down
4 changes: 2 additions & 2 deletions specs/CDPSessionIdSupport.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ See [DevToolsProtocol Target domain](https://chromedevtools.github.io/devtools-p

The DevToolsProtocol event messages also have sessionId field to indicate which target the event comes from.

However, the current WebView2 DevToolsProtocol APIs like [CallDevToolsProtocolMethod](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2#calldevtoolsprotocolmethod)
and [DevToolsProtocolEventReceived](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2devtoolsprotocoleventreceivedeventargs)
However, the current WebView2 DevToolsProtocol APIs like [CallDevToolsProtocolMethod](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2#calldevtoolsprotocolmethod)
and [DevToolsProtocolEventReceived](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2devtoolsprotocoleventreceivedeventargs)
don't support sessionId.

To support interaction with different parts of the page, we allow apps to specify a sessionId when calling DevToolsProtocol methods, as well as passing a sessionId to DevToolsProtocol event handlers, with empty string sessionId representing the default target of the top page.
Expand Down
2 changes: 1 addition & 1 deletion specs/DOMContentLoaded.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Background

In response to consumers' requests for an event similar to the old [WebView DOMContentLoaded](https://docs.microsoft.com/en-us/microsoft-edge/hosting/webview#mswebviewdomcontentloaded), the WebView2 team has introduced DOMContentLoaded API which indicates that the main DOM elements have finished loading.
In response to consumers' requests for an event similar to the old [WebView DOMContentLoaded](https://learn.microsoft.com/microsoft-edge/hosting/webview#mswebviewdomcontentloaded), the WebView2 team has introduced DOMContentLoaded API which indicates that the main DOM elements have finished loading.
In this document we describe the new API. We'd appreciate your feedback.

# Description
Expand Down
4 changes: 2 additions & 2 deletions specs/DefaultDownloadDialog.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ position below your button, and alternating open and close calls when the button
clicked on.

For more complex customizations, you can use the Download APIs -
[DownloadStarting](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2downloadstartingeventargs?view=webview2-1.0.961.33)
and [DownloadOperation](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2downloadoperation?view=webview2-1.0.961.33) - to build custom download UI.
[DownloadStarting](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2downloadstartingeventargs?view=webview2-1.0.961.33)
and [DownloadOperation](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2downloadoperation?view=webview2-1.0.961.33) - to build custom download UI.

# Examples
```cpp
Expand Down
2 changes: 1 addition & 1 deletion specs/DisableCrashReporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ interface ICoreWebView2Environment11 : ICoreWebView2Environment10 {
/// `FailureReportFolderPath` get the folder path of where minidump files is written.
/// Whenever a WebView2 process crashes, a crash dump file will be created in the crash dump folder.
/// A crash dump format is minidump files, please see
/// https://docs.microsoft.com/en-us/windows/win32/debug/minidump-files for detailed documentation.
/// https://learn.microsoft.com/windows/win32/debug/minidump-files for detailed documentation.
/// Normally when a single child process failed, a minidump will be generated and written to disk,
/// then `ProcessFailed` event is raised. But for unexpected crashes, minidump might not be generated
/// at all, despite whether `ProcessFailed` event is raised. For times, that there are multiple
Expand Down
4 changes: 2 additions & 2 deletions specs/ExecuteScriptWithResult.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Background
Our end developers have pointed out gaps in the existing [CoreWebView2.ExecuteScript](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2?view=webview2-1.0.1150.38#executescript) method, and it is necessary
Our end developers have pointed out gaps in the existing [CoreWebView2.ExecuteScript](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2?view=webview2-1.0.1150.38#executescript) method, and it is necessary
to provide a new method to let our end developers get more information in a more convenient manner.
The new ExecuteScriptWithResult method will provide exception information if the executed script
failed, and provides a new method to try to get the script execution result as a string rather than as JSON
Expand Down Expand Up @@ -284,7 +284,7 @@ interface ICoreWebView2_10 : ICoreWebView2_9 {
```

## .NET and WinRT
The documentation for the old interface [CoreWebView2.ExecuteScriptAsync(String) Method](https://docs.microsoft.com/en-us/dotnet/api/microsoft.web.webview2.core.corewebview2.executescriptasync?view=webview2-dotnet-1.0.1150.38#microsoft-web-webview2-core-corewebview2-executescriptasync(system-string)) is here.
The documentation for the old interface [CoreWebView2.ExecuteScriptAsync(String) Method](https://learn.microsoft.com/dotnet/api/microsoft.web.webview2.core.corewebview2.executescriptasync?view=webview2-dotnet-1.0.1150.38#microsoft-web-webview2-core-corewebview2-executescriptasync(system-string)) is here.
```c#
namespace Microsoft.Web.WebView2.Core
{
Expand Down
6 changes: 3 additions & 3 deletions specs/ExtendedProcessFailed.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Background
WebView2 provides applications with the [ProcessFailed](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2?view=webview2-1.0.705.50#add_processfailed) event so they can react accordingly when a process failure occurs. However, this event does not currently provide additional information about the process failure, nor does it cover the cases in which only subframes within the CoreWebView2 are impacted by the failure, or the cases in which a process other than the browser/render process fails.
WebView2 provides applications with the [ProcessFailed](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2?view=webview2-1.0.705.50#add_processfailed) event so they can react accordingly when a process failure occurs. However, this event does not currently provide additional information about the process failure, nor does it cover the cases in which only subframes within the CoreWebView2 are impacted by the failure, or the cases in which a process other than the browser/render process fails.

In this document we describe an extended version of the [PROCESS_FAILED_KIND](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2?view=webview2-1.0.705.50#corewebview2_process_failed_kind) enum, which covers the new scenarios in which the event is raised: frame-only render process failure, and process failures for processes other than the browser/render process. We also include a new version of the [ProcessFailedEventArgs](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2processfailedeventargs?view=webview2-1.0.705.50) that enables the host application to collect additional information about the process failure for their logging and telemetry purposes.
In this document we describe an extended version of the [PROCESS_FAILED_KIND](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2?view=webview2-1.0.705.50#corewebview2_process_failed_kind) enum, which covers the new scenarios in which the event is raised: frame-only render process failure, and process failures for processes other than the browser/render process. We also include a new version of the [ProcessFailedEventArgs](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2processfailedeventargs?view=webview2-1.0.705.50) that enables the host application to collect additional information about the process failure for their logging and telemetry purposes.

The updated API is detailed below. We'd appreciate your feedback.

Expand Down Expand Up @@ -394,7 +394,7 @@ void WebView_ProcessFailed(object sender, CoreWebView2ProcessFailedEventArgs e)
bool IsAppContentUri(Uri source)
{
// Sample virtual host name for the app's content.
// See CoreWebView2.SetVirtualHostNameToFolderMapping: https://docs.microsoft.com/en-us/dotnet/api/microsoft.web.webview2.core.corewebview2.setvirtualhostnametofoldermapping
// See CoreWebView2.SetVirtualHostNameToFolderMapping: https://learn.microsoft.com/dotnet/api/microsoft.web.webview2.core.corewebview2.setvirtualhostnametofoldermapping
return source.Host == "appassets.example";
}

Expand Down
2 changes: 1 addition & 1 deletion specs/IFramePermissionRequested.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ within the iframe are requesting access to priveleged resources. The permission
request types that we support are: Microphone, Camera, Geolocation,
Notifications, Other Sensors, and Clipboard Read.

We currently have a [PermissionRequested](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2permissionrequestedeventargs?view=webview2-1.0.1020.30)
We currently have a [PermissionRequested](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2permissionrequestedeventargs?view=webview2-1.0.1020.30)
event on our `CoreWebView2` which is raised for any permission requests
(either from webview or iframes). However, our customers do not have a way to
determine whether the request has come from the webview or an iframe and
Expand Down
2 changes: 1 addition & 1 deletion specs/IsPinchZoomEnabled.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Background

There are two types of zoom in Chromium: Browser Zoom and Pinch-Zoom:
- Browser zoom, referred to as “Page Zoom” or “Zoom” more generally, is what we get by using Ctrl + +(plus) or – (minus) or Ctrl + Mousewheel. This changes the size of a CSS pixel relative to a device independent pixel and so it will cause page layout to change. End developers can programmatically change browser Zoom properties including [IsZoomControlEnabled](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2settings?view=webview2-1.0.774.44#get_iszoomcontrolenabled) and [ZoomFactor](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2controller?view=webview2-1.0.774.44#get_zoomfactor). Setting ZoomFactor property causes the layout to change and enables scroll bar which lets users interact with the zoomed in content using mouse.
- Browser zoom, referred to as “Page Zoom” or “Zoom” more generally, is what we get by using Ctrl + +(plus) or – (minus) or Ctrl + Mousewheel. This changes the size of a CSS pixel relative to a device independent pixel and so it will cause page layout to change. End developers can programmatically change browser Zoom properties including [IsZoomControlEnabled](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2settings?view=webview2-1.0.774.44#get_iszoomcontrolenabled) and [ZoomFactor](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2controller?view=webview2-1.0.774.44#get_zoomfactor). Setting ZoomFactor property causes the layout to change and enables scroll bar which lets users interact with the zoomed in content using mouse.
- Pinch-zoom, referred to as “Page Scale” zoom, is performed as a post-rendering step, it changes the page scale factor property and scales the surface the web page is rendered onto when user perfoms a pinch zooming action. It does not change the layout but rather changes the viewport and clips the web content, the content outside of the viewport isn't visible onscreen and users can't reach this content using mouse.

Currently, the first type of zoom control is supported in WebView2 and modifying it has no effect on page scale zoom.
Expand Down
2 changes: 1 addition & 1 deletion specs/MultiProfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ interface ICoreWebView2Profile3;
interface ICoreWebView2ControllerOptions : IUnknown {
/// The `ProfileName` property specifies the profile's name. It has a maximum length of 64
/// characters excluding the null terminator and must be a valid file name.
/// See [Naming Files, Paths, and Namespaces](https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file)
/// See [Naming Files, Paths, and Namespaces](https://learn.microsoft.com/windows/win32/fileio/naming-a-file)
/// for more information on file names. It must contain only the following ASCII characters:
///
/// * alphabet characters: a-z and A-Z
Expand Down
8 changes: 4 additions & 4 deletions specs/NavigateWithWebResourceRequest.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@

# Background
Consumers of the old WebBrowser control that relied on the [Navigate](https://docs.microsoft.com/en-us/previous-versions/aa752133(v=vs.85)) API that allowed them to specify HTTP POST data and extra headers as part of navigation, [requested](https://github.com/MicrosoftEdge/WebViewFeedback/issues/69) same ability in WebView2.
Consumers of the old WebBrowser control that relied on the [Navigate](https://learn.microsoft.com/previous-versions/aa752133(v=vs.85)) API that allowed them to specify HTTP POST data and extra headers as part of navigation, [requested](https://github.com/MicrosoftEdge/WebViewFeedback/issues/69) same ability in WebView2.

# Description
We propose adding NavigateWithWebResourceRequest to CoreWebView2 as the API that allows a WebView2 to navigate with a specified [CoreWebView2WebResourceRequest](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/dotnet/0-9-628/microsoft-web-webview2-core-corewebview2). This allows the developer to specify extra headers and POST data as part of their request for navigation.
We also propose adding a CreateWebResourceRequest API to [CoreWebView2Environment](https://docs.microsoft.com/en-us/microsoft-edge/webview2/reference/dotnet/0-9-515/microsoft-web-webview2-core-corewebview2environment) so that developers can create the WebResourceRequest object they'd like to use with NavigateWithWebResourceRequest.
We propose adding NavigateWithWebResourceRequest to CoreWebView2 as the API that allows a WebView2 to navigate with a specified [CoreWebView2WebResourceRequest](https://learn.microsoft.com/microsoft-edge/webview2/reference/dotnet/0-9-628/microsoft-web-webview2-core-corewebview2). This allows the developer to specify extra headers and POST data as part of their request for navigation.
We also propose adding a CreateWebResourceRequest API to [CoreWebView2Environment](https://learn.microsoft.com/microsoft-edge/webview2/reference/dotnet/0-9-515/microsoft-web-webview2-core-corewebview2environment) so that developers can create the WebResourceRequest object they'd like to use with NavigateWithWebResourceRequest.

# Examples

Expand Down Expand Up @@ -67,7 +67,7 @@ isn't the type's default (for example an int-typed property that doesn't default
with a "///" comment above the member or type. -->

# API Details
<!-- The exact API, in MIDL3 format (https://docs.microsoft.com/en-us/uwp/midl-3/) -->
<!-- The exact API, in MIDL3 format (https://learn.microsoft.com/uwp/midl-3/) -->
```idl
[uuid(7fbad153-fb94-452e-acab-3cbb9ab341ec), object, pointer_default(unique)]
interface ICoreWebView2_2 : ICoreWebView2 {
Expand Down
2 changes: 1 addition & 1 deletion specs/Print.md
Original file line number Diff line number Diff line change
Expand Up @@ -722,7 +722,7 @@ interface ICoreWebView2PrintSettings2 : ICoreWebView2PrintSettings {
/// the name of any installed printers on the user OS, `ICoreWebView2PrintCompletedHandler` handler
/// will return `errorCode` as `S_OK` and `printStatus` as COREWEBVIEW2_PRINT_STATUS_PRINTER_UNAVAILABLE.
///
/// Use [Enum Printers](https://docs.microsoft.com/en-us/windows/win32/printdocs/enumprinters)
/// Use [Enum Printers](https://learn.microsoft.com/windows/win32/printdocs/enumprinters)
/// to enumerate available printers.
[propput] HRESULT PrinterName([in] LPCWSTR value);
}
Expand Down
2 changes: 1 addition & 1 deletion specs/SharedBuffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ namespace Microsoft.Web.WebView2.Core
{
/// A reference to the underlying memory of the shared buffer.
/// You can get IMemoryBufferByteAccess from the object to access the memory as an array of bytes.
/// See [I](https://docs.microsoft.com/en-us/uwp/api/windows.foundation.imemorybufferreference?view=winrt-22621)
/// See [IMemoryBufferReference](https://learn.microsoft.com/uwp/api/windows.foundation.imemorybufferreference?view=winrt-22621)
/// for more details.
Windows.Foundation.IMemoryBufferReference Buffer { get; };
}
Expand Down
Loading

0 comments on commit ab8420c

Please sign in to comment.