OffScreen - Add CreateBrowserAsync

Issue #3594
cefsharp · Jun 2, 2021 · 96117f9 · 96117f9
1 parent f6ea0de
commit 96117f9
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 0 deletions.
diff --git a/CefSharp.OffScreen/ChromiumWebBrowser.cs b/CefSharp.OffScreen/ChromiumWebBrowser.cs
@@ -329,6 +329,58 @@ public void CreateBrowser(IWindowInfo windowInfo = null, IBrowserSettings browse
             browserSettings = null;
         }
 
+        /// <summary>
+        /// Create the underlying CEF browser. The address and request context passed into the constructor
+        /// will be used. If a <see cref="Action{IBrowser}"/> delegate was passed
+        /// into the constructor it will not be called as this method overrides that value internally.
+        /// </summary>
+        /// <param name="windowInfo">Window information used when creating the browser</param>
+        /// <param name="browserSettings">Browser initialization settings</param>
+        /// <exception cref="System.Exception">An instance of the underlying offscreen browser has already been created, this method can only be called once.</exception>
+        /// <returns>
+        /// A <see cref="Task{IBrowser}"/> that represents the creation of the underlying CEF browser (<see cref="IBrowser"/> instance.
+        /// When the task completes then the CEF Browser will have been created and you can start performing basic tasks.
+        /// Note that the control's <see cref="BrowserInitialized"/> event will be invoked after this task completes.
+        /// </returns>
+        public Task<IBrowser> CreateBrowserAsync(IWindowInfo windowInfo = null, IBrowserSettings browserSettings = null)
+        {
+            if (browserCreated)
+            {
+                throw new Exception("An instance of the underlying offscreen browser has already been created, this method can only be called once.");
+            }
+
+            browserCreated = true;
+
+            if (browserSettings == null)
+            {
+                browserSettings = Core.ObjectFactory.CreateBrowserSettings(autoDispose: true);
+            }
+
+            if (windowInfo == null)
+            {
+                windowInfo = Core.ObjectFactory.CreateWindowInfo();
+                windowInfo.SetAsWindowless(IntPtr.Zero);
+            }
+
+            var tcs = new TaskCompletionSource<IBrowser>();
+
+            onAfterBrowserCreatedDelegate = new Action<IBrowser>(b =>
+            {
+                tcs.TrySetResultAsync(b);
+            });
+
+            managedCefBrowserAdapter.CreateBrowser(windowInfo, browserSettings, RequestContext, Address);
+
+            //Dispose of BrowserSettings if we created it, if user created then they're responsible
+            if (browserSettings.AutoDispose)
+            {
+                browserSettings.Dispose();
+            }
+            browserSettings = null;
+
+            return tcs.Task;
+        }
+
         /// <summary>
         /// Get/set the size of the Chromium viewport, in pixels.
         /// This also changes the size of the next rendered bitmap.

diff --git a/CefSharp.Test/OffScreen/OffScreenBrowserBasicFacts.cs b/CefSharp.Test/OffScreen/OffScreenBrowserBasicFacts.cs
@@ -85,6 +85,20 @@ public void BrowserRefCountDecrementedOnDispose()
             Assert.Equal(0, BrowserRefCounter.Instance.Count);
         }
 
+        [Fact]
+        public async Task CanCreateBrowserAsync()
+        {
+            using (var chromiumWebBrowser = new ChromiumWebBrowser("http://www.google.com", automaticallyCreateBrowser: false))
+            {
+                var browser = await chromiumWebBrowser.CreateBrowserAsync();
+
+                Assert.NotNull(browser);
+                Assert.False(browser.HasDocument);
+                Assert.NotEqual(0, browser.Identifier);
+                Assert.False(browser.IsDisposed);
+            }
+        }
+
         [Fact]
         public async Task CanLoadGoogleAndEvaluateScript()
         {