Adding Windows Forms and WPF sample apps along with .NET preview (0.9.515) (#27)

Adding Windows Forms and WPF sample apps along with .NET preview (0.9.515)

- Added WebView2WpfBrowser project
- Added WebView2WindowsForms project
- Both projects are configured to use the latest 0.9.515-prerelease nuget package with .NET preview

PR by peiche

Author: peiche-ms

.gitignore

@@ -1,2 +1,3 @@
 # VS Code
+.vs/
 .vscode/

README.md

@@ -1,23 +1,23 @@
 # WebView2 Samples
 
-This repository contain examples of how to use the [WebView 2 API](https://docs.microsoft.com/microsoft-edge/hosting/webview2). Please use [WebView2Samples issue tracker](https://github.com/MicrosoftEdge/WebView2Samples/issues) for sample issues and [WebViewFeedback issue tracker](https://github.com/MicrosoftEdge/WebViewFeedback/issues) for general WebView2 issues and feedback.
+This repository contain examples of how to use the [WebView 2 API](https://aka.ms/webview2). Please use [WebView2Samples issue tracker](https://github.com/MicrosoftEdge/WebView2Samples/issues) for sample issues and [WebViewFeedback issue tracker](https://aka.ms/webviewfeedback) for general WebView2 issues and feedback.
 
 ## 1. Getting Started Guide
 
 This Sample is found within the [GettingStartedGuide](https://github.com/MicrosoftEdge/WebView2Samples/tree/master/GettingStartedGuide) directory.
 
 Start with the [Microsoft Edge WebView2 getting-started guide](https://docs.microsoft.com/microsoft-edge/hosting/webview2/gettingstarted) to learn how to setup a WebView within a Win32 application.
 
-## 2. WebView2 API Sample
+## 2. WebView2 API Samples
 
-This Sample is found within the [WebView2APISample](WebView2APISample) directory.
+The Samples demonstrate all of the WebView2 SDK's features and their API use patterns. As we add more features to the WebView2 SDK, we will regularly update our sample applications. See [WebView2Samples.sln](./WebView2Samples.sln) that includes all three projects below:
 
-The Microsoft Edge WebView2APISample is a comprehensive example of our SDK's capabilities. As we add more functionality, we will update the API Sample.
+* Win32 C/C++ Sample can be found within [WebView2APISample](./WebView2APISample) directory.
+* WPF Sample can be found within [WebView2WpfBrowser](./WebView2WpfBrowser) directory.
+* Windows Forms Sample can be found within [WebView2WindowsFormsBrowser](./WebView2WindowsFormsBrowser) directory.
 
 ## 3. WebView2 Browser Example
 
 Clone the [WebView2Browser](https://github.com/MicrosoftEdge/WebView2Browser) by running `git clone https://github.com/MicrosoftEdge/WebView2Browser.git` to get started.
 
 Follow the [WebView2Browser guide](https://github.com/MicrosoftEdge/WebView2Browser) to learn how to build an application that utilizes multiple WebViews.
-
-

WebView2APISample/App.cpp

@@ -161,7 +161,7 @@ int APIENTRY wWinMain(HINSTANCE hInstance,
         }
     }
 
-    new AppWindow(initialUri);
+    new AppWindow(IDM_CREATION_MODE_WINDOWED, initialUri);
 
     int retVal = RunMessagePump();
 
@@ -210,18 +210,19 @@ static int RunMessagePump()
 }
 
 // Make a new thread.
-void CreateNewThread()
+void CreateNewThread(UINT creationModeId)
 {
     DWORD threadId;
-    HANDLE thread = CreateThread(nullptr, 0, ThreadProc, nullptr,
-                                 STACK_SIZE_PARAM_IS_A_RESERVATION, &threadId);
+    HANDLE thread = CreateThread(nullptr, 0, ThreadProc, 
+        reinterpret_cast<LPVOID>(creationModeId),
+        STACK_SIZE_PARAM_IS_A_RESERVATION, &threadId);
     s_threads.insert(std::pair<DWORD, HANDLE>(threadId, thread));
 }
 
 // This function is the starting point for new threads. It will open a new app window.
 static DWORD WINAPI ThreadProc(void* pvParam)
 {
-    new AppWindow();
+    new AppWindow(reinterpret_cast<UINT>(pvParam));
     return RunMessagePump();
 }
 

WebView2APISample/App.h

@@ -8,4 +8,4 @@ extern HINSTANCE g_hInstance;
 extern int g_nCmdShow;
 extern bool g_autoTabHandle;
 
-void CreateNewThread();
+void CreateNewThread(UINT creationModeId);

WebView2APISample/AppWindow.cpp

@@ -27,20 +27,22 @@
 #include "ViewComponent.h"
 
 using namespace Microsoft::WRL;
-DEFINE_ENUM_FLAG_OPERATORS(AppWindow::InitializeWebViewFlags);
 static constexpr size_t s_maxLoadString = 100;
 static constexpr UINT s_runAsyncWindowMessage = WM_APP;
 
 static thread_local size_t s_appInstances = 0;
 
 // Creates a new window which is a copy of the entire app, but on the same thread.
 AppWindow::AppWindow(
+    UINT creationModeId,
     std::wstring initialUri,
     std::function<void()> webviewCreatedCallback,
     bool customWindowRect,
     RECT windowRect,
     bool shouldHaveToolbar)
-    : m_initialUri(initialUri), m_onWebViewFirstInitialized(webviewCreatedCallback)
+    : m_creationModeId(creationModeId),
+      m_initialUri(initialUri),
+      m_onWebViewFirstInitialized(webviewCreatedCallback)
 {
     ++s_appInstances;
 
@@ -67,11 +69,12 @@ AppWindow::AppWindow(
         m_toolbar.Initialize(m_mainWindow);
     }
 
+    UpdateCreationModeMenu();
     ShowWindow(m_mainWindow, g_nCmdShow);
     UpdateWindow(m_mainWindow);
 
     RunAsync([this] {
-        InitializeWebView(kDefaultOption);
+        InitializeWebView();
     });
 }
 
@@ -283,14 +286,14 @@ bool AppWindow::ExecuteAppCommands(WPARAM wParam, LPARAM lParam)
     case IDM_EXIT:
         CloseAppWindow();
         return true;
-    case IDM_REINIT:
-        InitializeWebView(kDefaultOption);
-        return true;
-    case IDM_REINIT_WINDOWLESS_DCOMP_VISUAL:
-        InitializeWebView(kWindowlessDcompVisual);
+    case IDM_CREATION_MODE_WINDOWED:
+    case IDM_CREATION_MODE_VISUAL_DCOMP:
+    case IDM_CREATION_MODE_VISUAL_WINCOMP:
+        m_creationModeId = LOWORD(wParam);
+        UpdateCreationModeMenu();
         return true;
-    case IDM_REINIT_WINDOWLESS_WINCOMP_VISUAL:
-        InitializeWebView(kWindowlessWincompVisual);
+    case IDM_REINIT:
+        InitializeWebView();
         return true;
     case IDM_TOGGLE_FULLSCREEN_ALLOWED:
     {
@@ -304,10 +307,10 @@ bool AppWindow::ExecuteAppCommands(WPARAM wParam, LPARAM lParam)
         return true;
     }
     case IDM_NEW_WINDOW:
-        new AppWindow();
+        new AppWindow(m_creationModeId);
         return true;
     case IDM_NEW_THREAD:
-        CreateNewThread();
+        CreateNewThread(m_creationModeId);
         return true;
     case IDM_SET_LANGUAGE:
         ChangeLanguage();
@@ -358,7 +361,7 @@ std::function<void()> AppWindow::GetAcceleratorKeyFunction(UINT key)
         switch (key)
         {
         case 'N':
-            return [this] { new AppWindow(); };
+            return [this] { new AppWindow(m_creationModeId); };
         case 'Q':
             return [this] { CloseAppWindow(); };
         case 'S':
@@ -369,7 +372,7 @@ std::function<void()> AppWindow::GetAcceleratorKeyFunction(UINT key)
                 }
             };
         case 'T':
-            return [this] { CreateNewThread(); };
+            return [this] { CreateNewThread(m_creationModeId); };
         case 'W':
             return [this] { CloseWebView(); };
         }
@@ -379,19 +382,18 @@ std::function<void()> AppWindow::GetAcceleratorKeyFunction(UINT key)
 
 //! [CreateCoreWebView2Controller]
 // Create or recreate the WebView and its environment.
-void AppWindow::InitializeWebView(InitializeWebViewFlags webviewInitFlags)
+void AppWindow::InitializeWebView()
 {
-    m_lastUsedInitFlags = webviewInitFlags;
     // To ensure browser switches get applied correctly, we need to close
     // the existing WebView. This will result in a new browser process
     // getting created which will apply the browser switches.
     CloseWebView();
-
-    LPCWSTR subFolder = nullptr;
     m_dcompDevice = nullptr;
     m_wincompHelper = nullptr;
-    LPCWSTR additionalBrowserSwitches = nullptr;
-    if (webviewInitFlags & kWindowlessDcompVisual)
+
+    LPCWSTR subFolder = nullptr;
+
+    if (m_creationModeId == IDM_CREATION_MODE_VISUAL_DCOMP)
     {
         HRESULT hr = DCompositionCreateDevice2(nullptr, IID_PPV_ARGS(&m_dcompDevice));
         if (!SUCCEEDED(hr))
@@ -405,7 +407,7 @@ void AppWindow::InitializeWebView(InitializeWebViewFlags webviewInitFlags)
             return;
         }
     }
-    else if (webviewInitFlags & kWindowlessWincompVisual)
+    else if (m_creationModeId == IDM_CREATION_MODE_VISUAL_WINCOMP)
     {
         HRESULT hr = CreateWinCompCompositor();
         if (!SUCCEEDED(hr))
@@ -421,7 +423,6 @@ void AppWindow::InitializeWebView(InitializeWebViewFlags webviewInitFlags)
     }
     //! [CreateCoreWebView2EnvironmentWithOptions]
     auto options = Microsoft::WRL::Make<CoreWebView2EnvironmentOptions>();
-    CHECK_FAILURE(options->put_AdditionalBrowserArguments(additionalBrowserSwitches));
     if(!m_language.empty())
         CHECK_FAILURE(options->put_Language(m_language.c_str()));
     HRESULT hr = CreateCoreWebView2EnvironmentWithOptions(
@@ -448,7 +449,7 @@ void AppWindow::InitializeWebView(InitializeWebViewFlags webviewInitFlags)
     }
 }
 
-// This is the callback passed to CreateWebViewEnvironmnetWithDetails.
+// This is the callback passed to CreateWebViewEnvironmentWithOptions.
 // Here we simply create the WebView.
 HRESULT AppWindow::OnCreateEnvironmentCompleted(
     HRESULT result, ICoreWebView2Environment* environment)
@@ -539,7 +540,7 @@ void AppWindow::ReinitializeWebView()
     // Save the settings component from being deleted when the WebView is closed, so we can
     // copy its properties to the next settings component.
     m_oldSettingsComponent = MoveComponent<SettingsComponent>();
-    InitializeWebView(m_lastUsedInitFlags);
+    InitializeWebView();
 }
 
 void AppWindow::ReinitializeWebViewWithNewBrowser()
@@ -559,7 +560,7 @@ void AppWindow::ReinitializeWebViewWithNewBrowser()
     // Make sure the browser process inside webview is closed
     ProcessComponent::EnsureProcessIsClosed(webviewProcessId, 2000);
 
-    InitializeWebView(m_lastUsedInitFlags);
+    InitializeWebView();
 }
 
 void AppWindow::RestartApp()
@@ -637,8 +638,7 @@ void AppWindow::RegisterEventHandlers()
                 CHECK_FAILURE(args->GetDeferral(&deferral));
                 AppWindow* newAppWindow;
 
-                newAppWindow = new AppWindow(L"");
-
+                newAppWindow = new AppWindow(m_creationModeId, L"");
                 newAppWindow->m_isPopupWindow = true;
                 newAppWindow->m_onWebViewFirstInitialized = [args, deferral, newAppWindow]() {
                     CHECK_FAILURE(args->put_NewWindow(newAppWindow->m_webView.get()));
@@ -742,7 +742,7 @@ void AppWindow::CloseWebView(bool cleanupUserDataFolder)
         // developers specify userDataFolder during WebView environment
         // creation, they would need to pass in that explicit value here.
         // For more information about userDataFolder:
-        // https://docs.microsoft.com/microsoft-edge/hosting/webview2/reference/webview2.idl#createwebview2environmentwithdetails
+        // https://docs.microsoft.com/microsoft-edge/webview2/reference/win32/0-9-488/webview2-idl#createwebview2environmentwithoptions
         WCHAR userDataFolder[MAX_PATH] = L"";
         // Obtain the absolute path for relative paths that include "./" or "../"
         _wfullpath(
@@ -752,7 +752,7 @@ void AppWindow::CloseWebView(bool cleanupUserDataFolder)
         std::wstring message = L"Are you sure you want to clean up the user data folder at\n";
         message += userDataFolderPath;
         message += L"\n?\nWarning: This action is not reversible.\n\n";
-        message += L"Click No if there are other open WebView instnaces.\n";
+        message += L"Click No if there are other open WebView instances.\n";
 
         if (MessageBox(m_mainWindow, message.c_str(), L"Cleanup User Data Folder", MB_YESNO) ==
             IDYES)
@@ -959,3 +959,15 @@ HRESULT AppWindow::CreateWinCompCompositor()
     }
     return hr;
 }
+
+void AppWindow::UpdateCreationModeMenu()
+{
+    HMENU hMenu = GetMenu(m_mainWindow);
+    CheckMenuRadioItem(
+        hMenu,
+        IDM_CREATION_MODE_WINDOWED,
+        IDM_CREATION_MODE_VISUAL_WINCOMP,
+        m_creationModeId,
+        MF_BYCOMMAND);
+}
+

WebView2APISample/AppWindow.h

@@ -24,6 +24,7 @@ class AppWindow
 {
 public:
     AppWindow(
+        UINT creationModeId,
         std::wstring initialUri = L"https://www.bing.com/",
         std::function<void()> webviewCreatedCallback = nullptr,
         bool customWindowRect = false,
@@ -57,14 +58,9 @@ class AppWindow
 
     void RunAsync(std::function<void(void)> callback);
 
-    enum InitializeWebViewFlags
-    {
-        kDefaultOption = 0,
-        kWindowlessDcompVisual = 1 << 0,
-        kWindowlessWincompVisual = 1 << 1,
-    };
 private:
     static PCWSTR GetWindowClass();
+
     static INT_PTR CALLBACK About(HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam);
 
     static LRESULT CALLBACK
@@ -76,7 +72,7 @@ class AppWindow
     bool ExecuteAppCommands(WPARAM wParam, LPARAM lParam);
 
     void ResizeEverything();
-    void InitializeWebView(InitializeWebViewFlags webviewInitFlags);
+    void InitializeWebView();
     HRESULT OnCreateEnvironmentCompleted(HRESULT result, ICoreWebView2Environment* environment);
     HRESULT OnCreateCoreWebView2ControllerCompleted(HRESULT result, ICoreWebView2Controller* controller);
     HRESULT DeleteFileRecursive(std::wstring path);
@@ -86,6 +82,7 @@ class AppWindow
     void CloseWebView(bool cleanupUserDataFolder = false);
     void CloseAppWindow();
     void ChangeLanguage();
+    void UpdateCreationModeMenu();
     std::wstring GetLocalPath(std::wstring path);
 
     void DeleteAllComponents();
@@ -96,6 +93,7 @@ class AppWindow
     HWND m_mainWindow = nullptr;
     Toolbar m_toolbar;
     std::function<void()> m_onWebViewFirstInitialized;
+    DWORD m_creationModeId = 0;
 
     // The following is state that belongs with the webview, and should
     // be reinitialized along with it. Everything here is undefined when
@@ -106,10 +104,6 @@ class AppWindow
 
     // All components are deleted when the WebView is closed.
     std::vector<std::unique_ptr<ComponentBase>> m_components;
-
-    // This state is preserved between WebViews so we can recreate
-    // a new WebView based on the settings of the old one.
-    InitializeWebViewFlags m_lastUsedInitFlags;
     std::unique_ptr<SettingsComponent> m_oldSettingsComponent;
 
     std::wstring m_language;

WebView2APISample/HostObjectSample.idl

@@ -15,8 +15,12 @@ library HostObjectSampleLibrary
         [propget] HRESULT Property([out, retval] BSTR* stringResult);
         [propput] HRESULT Property([in] BSTR stringValue);
 
+        [propget] HRESULT IndexedProperty(INT index, [out, retval] BSTR * stringResult);
+        [propput] HRESULT IndexedProperty(INT index, [in] BSTR stringValue);
+
         // Demonstrate native calling back into JavaScript.
         HRESULT CallCallbackAsynchronously([in] IDispatch* callbackParameter);
+
     };
     //! [AddHostObjectInterface]
 

WebView2APISample/HostObjectSampleImpl.cpp

@@ -36,6 +36,20 @@ STDMETHODIMP HostObjectSample::put_Property(BSTR stringValue)
     return S_OK;
 }
 
+STDMETHODIMP HostObjectSample::get_IndexedProperty(INT index, BSTR* stringResult)
+{
+    std::wstring result(L"[");
+    result = result + std::to_wstring(index) + L"] is " + m_propertyValues[index] + L".";
+    *stringResult = SysAllocString(result.c_str());
+    return S_OK;
+}
+
+STDMETHODIMP HostObjectSample::put_IndexedProperty(INT index, BSTR stringValue)
+{
+    m_propertyValues[index] = stringValue;
+    return S_OK;
+}
+
 STDMETHODIMP HostObjectSample::CallCallbackAsynchronously(IDispatch* callbackParameter)
 {
     wil::com_ptr<IDispatch> callbackParameterForCapture = callbackParameter;

WebView2APISample/HostObjectSampleImpl.h

@@ -7,6 +7,7 @@
 #include "stdafx.h"
 
 #include <functional>
+#include <map>
 #include <string>
 #include <wrl\client.h>
 
@@ -29,6 +30,8 @@ class HostObjectSample : public Microsoft::WRL::RuntimeClass<
     // Demonstrate getting and setting a property.
     STDMETHODIMP get_Property(BSTR* stringResult) override;
     STDMETHODIMP put_Property(BSTR stringValue) override;
+    STDMETHODIMP get_IndexedProperty(INT index, BSTR* stringResult) override;
+    STDMETHODIMP put_IndexedProperty(INT index, BSTR stringValue) override;
 
     // Demonstrate native calling back into JavaScript.
     STDMETHODIMP CallCallbackAsynchronously(IDispatch* callbackParameter) override;
@@ -47,6 +50,7 @@ class HostObjectSample : public Microsoft::WRL::RuntimeClass<
 
 private:
     std::wstring m_propertyValue;
+    std::map<INT, std::wstring> m_propertyValues;
     wil::com_ptr<IDispatch> m_callback;
     RunCallbackAsync m_runCallbackAsync;
     wil::com_ptr<ITypeLib> m_typeLib;