Aug 24, 2020 WebView2 runs on any version of Windows, reaching back to Windows 7. Microsoft also claims that it works on versions of Windows Server all the way back to the preposterously old Windows Server 2008.
-->WinUI is a user interface layer that contains modern controls and styles for building Windows apps, both Desktop and UWP. As the native UI layer in Windows, it embodies Fluent Design, giving each Windows app the polished feel that users expect. WinUI 3 is the latest version of the WinUI framework, shipping later this year. In the search bar, type Microsoft.Web.WebView2 choose Microsoft.Web.WebView2. Ready to start developing apps using the WebView2 API. To build and run the project, select F5. The running project displays an empty window.
Unlike WebView(EDGEhtml), please, please support printing of contents of a webview. All the crazy gyrations needed to print webview content in a UWP application today doesn't work well. These tokens gain access to Microsoft Cloud API and any other API secured by the Microsoft identity platform. This version supports adding authentication functionality to your.NET based client on Windows desktop (.NET 4.5+), UWP,.NET Core, Xamarin iOS and Xamarin Android.
In this article, get started creating your first WebView2 app and learn about the main features of WebView2. For more information on individual APIs, navigate to API reference.
Prerequisites
Ensure you install the following list of pre-requisites before proceeding.
- WebView2 Runtime or any Microsoft Edge (Chromium) non-stable channel installed on supported OS (currently Windows 10, Windows 8.1, and Windows 7).
- Visual Studio 2017 or later.
Step 1 - Create a single-window app
Start with a basic desktop project that contains a single main window.
In Visual Studio, choose WPF .NET Core App (or WPF .NET Framework App) > Next.
Enter values for Project name and Location. Choose .NET Framework 4.6.2 or later (or .NET Core 3.0 or later).
To create your project, choose Create.
Step 2 - Install WebView2 SDK
Edge Webview2 Python
Use NuGet to add the WebView2 SDK to the project.
Hover on the projecty, open the contextual menu (right-click), and choose Manage NuGet Packages....
Manage NuGet packages
In the search bar, type
Microsoft.Web.WebView2
> choose Microsoft.Web.WebView2.Ready to start developing apps using the WebView2 API. To build and run the project, select
F5
. The running project displays an empty window.
Step 3 - Create a single WebView
Next add a WebView to your app.
In the
MainWindow.xaml
file, to add the WebView2 XAML namespace, insert the following line inside the<Window/>
tag.Ensure the code in
MainWindow.xaml
looks like the following code snippet.To add the WebView2 control, replace the
<Grid>
tags with the following code snippet. TheSource
property sets the initial URI displayed in the WebView2 control.To build and run the project, select
F5
Ensure your WebView2 control displays https://www.microsoft.com.
Step 4 - Navigation
Add the ability to allow users to change the URL that the WebView2 control displays by adding an address bar to the app.
In the
MainWindow.xaml
file, add an address bar by copying and pasting the following code snippet inside the<DockPanel>
that contains the WebView.Ensure the
<DockPanel>
section of theMainWindow.xaml
file matches the following code snippet.In Visual Studio, in the
MainWindow.xaml.cs
file, to add theCoreWebView2
namespace, insert the following code snippet at the top.In the
MainWindow.xaml.cs
file, copy the following code snippet to create theButtonGo_Click
method, which navigates the WebView to the URL entered in the address bar.To build and run the project, select
F5
. Type a new URL in the address bar and choose Go. For example, typehttps://www.bing.com
. Ensure the WebView2 control navigates to the URL.Note
Make sure a complete URL is entered in the address bar. An
ArgumentException
is thrown if the URL does not start withhttp://
orhttps://
.
Step 5 - Navigation events
During webpage navigation, the WebView2 control raises events. The app that hosts WebView2 controls listens for the following events.
NavigationStarting
SourceChanged
ContentLoading
HistoryChanged
NavigationCompleted
For more information, navigate to Navigation Events.
Navigation events
When an error occurs, the following events are raised and may depend on navigation to an error webpage.
SourceChanged
ContentLoading
HistoryChanged
Note
If an HTTP redirect occurs, there are multiple NavigationStarting
events in a row.
To demonstrate how to use the events, register a handler for NavigationStarting
that cancels any non-HTTPS requests.
In the MainWindow.xaml.cs
file, modify the constructor to match the following code snippet and add the EnsureHttps
function.
In the constructor, EnsureHttps
is registered as the event handler on the NavigationStarting
event on the WebView2 control.
To build and run the project, select F5
. Ensure when navigating to an HTTP site, the WebView remains unchanged. However, the WebView navigates to HTTPS sites.
Step 6 - Scripting
You may use host apps to inject JavaScript code into WebView2 controls at runtime. You may task WebView to run arbitrary JavaScript or add initialization scripts. The injected JavaScript applies to all new top-level documents and any child frames until the JavaScript is removed. The injected JavaScript is run with specific timing.
- Run it after the creation of the global object.
- Run it before any other script included in the HTML document is run.
As an example, add scripts that send an alert when a user navigates to non-HTTPS sites. Modify the EnsureHttps
function to inject a script into the web content that uses ExecuteScriptAsync method.
To build and run the project, select F5
. Ensure the app displays an alert when you navigate to a website that doesn't use HTTPS.
Step 7 - Communication between host and web content
The host and web content may communicate in the following ways using postMessage
.
- Web content in a WebView2 control may post a message to the host using
window.chrome.webview.postMessage
. The host handles the message using any registeredWebMessageReceived
on the host. - Hosts post messages to web content in a WebView2 control using
CoreWebView2.PostWebMessageAsString
orCoreWebView2.PostWebMessageAsJSON
. The messages are caught by handlers added towindow.chrome.webview.addEventListener
.
The communication mechanism passes messages from web content to the host using native capabilities.
In your project, when the WebView2 control navigates to a URL, it displays the URL in the address bar and alerts the user of the URL displayed in the WebView2 control.
In the
MainWindow.xaml.cs
file, update your constructor and create anInitializeAsync
function to match the following code snippet. TheInitializeAsync
function awaits EnsureCoreWebView2Async because the initialization ofCoreWebView2
is asynchronous.After CoreWebView2 is initialized, register an event handler to respond to
WebMessageReceived
. InMainWindow.xaml.cs
, updateInitializeAsync
and addUpdateAddressBar
using the following code snippet.In order for the WebView to send and respond to the web message, after
CoreWebView2
is initialized, the host:- Injects a script to the web content that registers a handler to print message from the host.
- Injects a script to the web content that posts the URL to the host.
In the
MainWindow.xaml.cs
file, updateInitializeAsync
to match the following code snippet.To build and run the app, select
F5
. Now, the address bar displays the URI in the WebView2 control. When you successfully navigate to a new URI, the WebView2 control alerts the user of the URI that's displayed in the WebView2 control.addressBar
Congratulations, you built your first WebView2 app.
Webview2 Uwp App
Next steps
To continue learning more about WebView2, navigate to the following resources.
Webview2 Blank
See also
Webview2 Uwp C#
- For a comprehensive example of WebView2 capabilities, navigate to WebView2Samples repo on GitHub.
- For more detailed information about WebView2 API, navigate to API reference.
- For more information about WebView2, navigate to WebView2 Resources.
Webview Uwp Unity
Getting in touch with the Microsoft Edge WebView team
Share your feedback to help build richer WebView2 experiences. To submit feature requests or bugs, or search for known issues, navigate to the Microsoft Edge WebView feedback repo.