You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This sample, **WebView2APISample**, embeds a WebView2 control within a Win32 application.
22
23
23
-
The WebView2APISample is an example of an application that embeds a WebView within a Win32 native application. It is built as a Win32 [Visual Studio 2019](https://visualstudio.microsoft.com/vs/) project and makes use of both C++ and HTML/CSS/JavaScript in the WebView2 environment.
24
+
<!-- distinctive project type and language: -->
25
+
This sample is built as a Win32 Visual Studio 2019 project. It uses C++ in the native environment together with HTML/CSS/JavaScript in the WebView2 environment. This sample showcases many of WebView2's event handlers and API methods that allow a native Win32 application to directly interact with a WebView, and vice versa.
24
26
25
-
The API Sample showcases a selection of WebView2's event handlers and API methods that allow a native Win32 application to directly interact with a WebView and vice versa.
27
+
<!-- special notes about this particular sample: -->
28
+
The solution file for this sample is in the parent directory: `SampleApps/WebView2Samples.sln`. The solution file includes a copy of some of the other, sibling samples for other frameworks or platforms.
26
29
27
-
If this is your first time using WebView, we recommend first following the [Getting Started](https://learn.microsoft.com/microsoft-edge/webview2/gettingstarted/win32) guide, which goes over how to create a WebView2 and walks through some basic WebView2 functionality.
30
+
<!-- link to regular docs: -->
31
+
To use this sample, see [Win32 sample app](https://learn.microsoft.com/microsoft-edge/webview2/samples/webview2apissample).
28
32
29
-
To learn more specifics about events and API Handlers in WebView2, you can refer to the [WebView2 Reference Documentation](https://learn.microsoft.com/microsoft-edge/webview2/webview2-api-reference).
33
+
<!-- screenshot of running sample app: -->
34
+
This is the main WebView2 sample. The running **WebView2APISample** app window shows the WebView2 SDK version and also the WebView2 Runtime version and path. The **WebView2APISample** app has several menus containing many menuitems that demonstrate a broad range of WebView2 APIs:
30
35
31
-
## Prerequisites
32
-
33
-
-[Microsoft Edge (Chromium)](https://www.microsoftedgeinsider.com/download/) installed on a supported OS. Currently we recommend the latest version of the Edge Canary channel.
34
-
-[Visual Studio](https://visualstudio.microsoft.com/vs/) with C++ support installed.
35
-
- Latest pre-release version of our [WebView2 SDK](https://aka.ms/webviewnuget), which is included in this project.
36
-
37
-
## Build the WebView2 API Sample
38
-
39
-
Clone the repository and open the solution in Visual Studio. WebView2 is already included as a NuGet package* in this project.
40
-
41
-
- Clone this repository
42
-
- Open the solution in Visual Studio 2019**
43
-
- Set the target you want to build (Debug/Release, x86/x64/ARM64)
44
-
- Build the project file: _WebView2APISample.vcxproj_
45
-
46
-
That's it! Everything should be ready to just launch the app.
47
-
48
-
*You can get the WebView2 NugetPackage through the Visual Studio NuGet Package Manager.
49
-
50
-
**You can also use Visual Studio 2017 by changing the project's Platform Toolset in Project Properties/Configuration properties/General/Platform Toolset. You might also need to change the Windows SDK to the latest version available to you.
51
-
52
-
## Application architecture
53
-
54
-
The API Sample App is an example of a hybrid application. It has two parts: a Win32 native part and a WebView part. The Win32 part can access native Windows APIs, while the WebView container can utilize standard web technologies (HTML, CSS, JavaScript).
55
-
56
-
This hybrid approach allows you to create and iterate faster using web technologies, while still being able to take advantage of native functionalities. The Sample App specifically demonstrates how both components can interact with each other.
57
-
58
-
Both of these parts of the Sample App are displayed in the image below:
1. Section One: The top part of the Sample App is a Win32 component written in C++. This part of the application takes in UI inputs from the user and uses them to control the WebView.
63
-
64
-
2. Section Two: The main part of the Sample App is a WebView that can be repurposed using standard web technologies (HTML/CSS/JavaScript). It can be navigated to websites or local content.
65
-
66
-
## Project Files
67
-
68
-
This section briefly explains some key files within the repository. The WebView2APISample is divided vertically into components, instead of horizontally into layers. Each component implements the whole workflow of a category of example features, from listening for menu commands, to calling WebView API methods to implement them.
69
-
70
-
#### 1. App.cpp
71
-
72
-
This is the top-level file that runs the Sample App. It reads command line options, sets up the process environment, and handles the app's threading model.
73
-
74
-
#### 2. AppWindow.cpp
75
-
76
-
This file implements the application window. In this file, we first set up all the Win32 controls. Second, we initialize the WebView Environment and the WebView. Third, we add some event handlers to the WebView and create all the components that handle various features of the application. The `AppWindow` class itself handles commands from the application's Window menu.
77
-
78
-
#### 3. FileComponent.cpp
79
-
80
-
This component handles commands from the File menu (except for Exit), as well as the `DocumentTitleChanged` event.
81
-
82
-
#### 4. ScriptComponent.cpp
83
-
84
-
This component handles commands from the Script menu, which involve interacting with the WebView by injecting JavaScript, posting WebMessages, adding native objects to the webpage, or using the DevTools protocol to communicate with the webpage.
85
-
86
-
#### 5. ProcessComponent.cpp
87
-
88
-
This component handles commands from the Process menu, which involve interaction with the browser's process. It also handles the ProcessFailed event, in case the browser process or one of its render process crashes or is unresponsive.
89
-
90
-
#### 6. SettingsComponent.cpp
91
-
92
-
This component handles commands from the Settings menu, and is also in charge of copying settings from an old WebView when a new one is created. Most code that interacts with the `ICoreWebView2Settings` interface can be found here.
93
-
94
-
#### 7. ViewComponent.cpp
95
-
96
-
This component handles commands from the View menu, and any functionality related to sizing and visibility of the WebView. When the app window is resized, minimized, or restored, `ViewComponent` will resize, hide, or show the WebView in response. It also responds to the `ZoomFactorChanged` event.
97
-
98
-
#### 8. ScenarioWebMessage.cpp and ScenarioWebMessage.html
99
-
100
-
This component is created when you select the Scenario/Web Messaging menu item. It implements an example application with a C++ part and an HTML+JavaScript part, which communicate with each other by asynchronously posting and receiving messages.
#### 9. ScenarioAddHostObject.cpp and ScenarioAddHostObject.html
105
-
106
-
This component is created when you select the Scenario/Host Objects menu item. It demonstrates communication between the native app and the HTML webpage by means of host object injection. The interface of the host object is declared in `HostObjectSample.idl`, and the object itself is implemented in `HostObjectSampleImpl.cpp`.
107
-
108
-
## Key Functions
109
-
110
-
The section below briefly explains some of the key functions in the Sample App.
111
-
112
-
### AppWindow.cpp
113
-
114
-
#### InitializeWebView()
115
-
116
-
In the AppWindow file, we use the InitializeWebView() function to create the WebView2 environment by using [CreateCoreWebView2EnvironmentWithOptions](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/webview2-idl#createcorewebview2environmentwithoptions).
117
-
118
-
Once we've created the environment, we create the WebView by using `CreateCoreWebView2Controller`.
119
-
120
-
To see these API calls in action, refer to the following code snippet from `InitializeWebView()`.
if (hr == HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND))
131
-
{
132
-
MessageBox(
133
-
m_mainWindow,
134
-
L"Couldn't find Edge installation. "
135
-
"Do you have a version installed that's compatible with this "
136
-
"WebView2 SDK version?",
137
-
nullptr, MB_OK);
138
-
}
139
-
else
140
-
{
141
-
ShowFailure(hr, L"Failed to create webview environment");
142
-
}
143
-
}
144
-
```
145
-
146
-
#### OnCreateEnvironmentCompleted()
147
-
148
-
This callback function is passed to `CreateCoreWebView2EnvironmentWithOptions` in `InitializeWebView()`. It stored the environment pointer and then uses it to create a new WebView.
This callback function is passed to `CreateCoreWebView2Controller` in `InitializeWebView()`. Here, we initialize the WebView-related state, register some event handlers, and create the app components.
169
-
170
-
#### RegisterEventHandlers()
171
-
172
-
This function is called within `CreateCoreWebView2Controller`. It sets up some of the event handlers used by the application, and adds them to the WebView.
173
-
174
-
To read more about event handlers in WebView2, you can refer to this [documentation](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2).
175
-
176
-
Below is a code snippet from `RegisterEventHandlers()`, where we set up an event handler for the `NewWindowRequested` event. This event is fired when JavaScript in the webpage calls `window.open()`, and our handler makes a new `AppWindow` and passes the new window's WebView back to the browser so it can return it from the `window.open()` call. Unlike our calls to `CreateCoreWebView2EnvironmentWithOptions` and `CreateCoreWebView2Controller`, instead of providing a method for the callback, we just provide a C++ lambda right then and there.
The `ScenarioWebMessage` files show how the Win32 Host can modify the WebView, how the WebView can modify the Win32Host, and how the WebView can modify itself by accessing information from the Win32 Host. This is done asynchronously.
204
-
205
-
The following sections demonstrate how each discrete function works using the Sample App and then explains how to implement this functionality.
206
-
207
-
First, navigate to the ScenarioWebMessage application within the Sample App, using the following steps:
208
-
209
-
1. Open the Sample App
210
-
2. Click on Scenario
211
-
3. Click on Web Messaging
212
-
213
-
The WebView should display a simple webpage titled: "WebMessage sample page". The code for this page can be found in the `ScenarioWebMessage.html` file.
To better understand ScenarioWebMessage functionality, you can either follow the instructions on the page or the steps detailed below.
218
-
219
-
#### 1. Posting Messages (Win32 Host to WebView)
220
-
221
-
The following steps show how the Win32 Host can modify a WebView. In this example, you will turn the text blue:
222
-
223
-
1. Click on Script in the Toolbar
224
-
2. Click on Post Web Message JSON
225
-
226
-
A dialog box with the pre-written code `{"SetColor":"blue"}` should appear.
227
-
228
-
3. Click OK
229
-
230
-
The text under Posting Messages should now be blue.
231
-
232
-
Here's how it works:
233
-
234
-
1. In `ScriptComponent.cpp`, we use [PostWebMessageAsJson](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2#postwebmessageasjson) to post user input to the `ScenarioMessage.html` web application.
235
-
236
-
```cpp
237
-
// Prompt the user for some JSON and then post it as a web message.
2. Within the web application, event listeners are used to receive and respond to the web message. The code snippet below is from `ScenarioWebMessage.html`. The event listener changes the color of the text if it reads "SetColor".
#### 2. Receiving Messages (WebView to Win32 Host)
264
-
265
-
The following steps show how the WebView can modify the Win32 Host App by changing the title of the Win32 App:
266
-
267
-
1. Locate the Title of the Sample App - the top left of the window next to the icon.
268
-
2. Under the Receiving Message section, fill out the form with the new title of your choice.
269
-
3. Click Send
270
-
271
-
Locate the Title of the Sample App, it should have changed to the title you have just inputted.
272
-
273
-
Here's how it works:
274
-
275
-
1. Within `ScenarioWebMessage.html`, we call [window.chrome.webview.postMessage()](https://developer.mozilla.org/docs/Web/API/Window/postMessage) to send the user input to the host application. Refer to code snippet below:
276
-
277
-
```js
278
-
functionSetTitleText() {
279
-
let titleText =document.getElementById("title-text");
2. Within `ScenarioWebMessage.cpp`, we use [add_WebMessageReceived](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2#add_webmessagereceived) to register the event handler. When we receive the event, after validating the input, we change the title of the App Window.
285
-
286
-
```cpp
287
-
// Setup the web message received event handler before navigating to
The following steps show how the WebView can get information from the Win32 Host and modify itself by displaying the size of the Win32 App.
316
-
317
-
1. Under RoundTrip, click GetWindowBounds
318
-
319
-
The box underneath the button should display the bounds for the Sample App.
320
-
321
-
Here's how it works:
322
-
323
-
1. When the 'Get window bounds' button is clicked, the `GetWindowBounds` function in `ScenarioWebMessage.html` gets called. It uses [window.chrome.webview.postMessage()](https://developer.mozilla.org/docs/Web/API/Window/postMessage) to send a message to the host application.
2. Within `ScenarioWebMessage.cpp`, we use [add_WebMessageReceived](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2#add_webmessagereceived) to register the received event handler. After validating the input, the event handler gets window bounds from the App Window. [PostWebMessageAsJson](https://learn.microsoft.com/microsoft-edge/webview2/reference/win32/icorewebview2#postwebmessageasjson) sends the bounds to the web application.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [email protected] with any additional questions or comments.
0 commit comments