Skip to content

Commit 798b253

Browse files
mikehoffmsmikehoffms
committed
lead-ins for 2 new Exper APIs
1 parent 6ee89ca commit 798b253

1 file changed

Lines changed: 93 additions & 88 deletions

File tree

  • microsoft-edge/webview2/release-notes

‎microsoft-edge/webview2/release-notes/index.md‎

Lines changed: 93 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -80,93 +80,7 @@ The following Experimental APIs have been added in this Prerelease SDK.
8080

8181

8282
<!-- ---------- -->
83-
###### DefaultBackgroundColor API<!-- todo: feature-oriented heading -->
84-
85-
<!-- todo: lead-in - https://github.com/MicrosoftEdge/WebView2Feedback/pull/4981/files -->
86-
87-
##### [.NET/C#](#tab/dotnetcsharp)
88-
89-
* `CoreWebView2ControllerOptions` Class:
90-
* [CoreWebView2ControllerOptions.DefaultBackgroundColor Property](/dotnet/api/microsoft.web.webview2.core.corewebview2controlleroptions.defaultbackgroundcolor?view=webview2-dotnet-1.0.3079-prerelease&preserve-view=true)
91-
92-
##### [WinRT/C#](#tab/winrtcsharp)
93-
94-
* [CoreWebView2ControllerOptions Class](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2controlleroptions?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true)
95-
* [CoreWebView2ControllerOptions.DefaultBackgroundColor Property](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2controlleroptions?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true#defaultbackgroundcolor)
96-
97-
##### [Win32/C++](#tab/win32cpp)
98-
99-
* [ICoreWebView2ExperimentalControllerOptions3](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalcontrolleroptions3?view=webview2-1.0.3079-prerelease&preserve-view=true)
100-
* [ICoreWebView2ExperimentalControllerOptions3::get_DefaultBackgroundColor](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalcontrolleroptions3?view=webview2-1.0.3079-prerelease&preserve-view=true#get_defaultbackgroundcolor)
101-
* [ICoreWebView2ExperimentalControllerOptions3::put_DefaultBackgroundColor](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalcontrolleroptions3?view=webview2-1.0.3079-prerelease&preserve-view=true#put_defaultbackgroundcolor)
102-
103-
---
104-
105-
106-
<!-- ---------- -->
107-
###### FrameCreatedEvent API<!-- todo: feature-oriented heading -->
108-
109-
<!-- todo: lead-in - https://github.com/MicrosoftEdge/WebView2Feedback/pull/4982 -->
110-
111-
##### [.NET/C#](#tab/dotnetcsharp)
112-
113-
* [CoreWebView2Frame Class](/dotnet/api/microsoft.web.webview2.core.corewebview2frame?view=webview2-dotnet-1.0.3079-prerelease&preserve-view=true)
114-
* [CoreWebView2Frame.FrameCreated Event](/dotnet/api/microsoft.web.webview2.core.corewebview2frame.framecreated?view=webview2-dotnet-1.0.3079-prerelease&preserve-view=true)
115-
<!-- todo: .Stop Property, like WinRT has? -->
116-
117-
##### [WinRT/C#](#tab/winrtcsharp)
118-
119-
* [CoreWebView2Frame Class](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2frame?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true)
120-
* [CoreWebView2Frame.FrameCreated Event](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2frame?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true#framecreated)
121-
* [CoreWebView2Frame.Stop Property](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2frame?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true#stop)
122-
123-
##### [Win32/C++](#tab/win32cpp)
124-
125-
* [ICoreWebView2ExperimentalFrame8](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalframe8?view=webview2-1.0.3079-prerelease&preserve-view=true)
126-
* [ICoreWebView2ExperimentalFrame8::add_FrameCreated](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalframe8?view=webview2-1.0.3079-prerelease&preserve-view=true#add_framecreated)
127-
* [ICoreWebView2ExperimentalFrame8::remove_FrameCreated](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalframe8?view=webview2-1.0.3079-prerelease&preserve-view=true#remove_framecreated)
128-
<!-- todo: add Stop Property, like WinRT has? event, or property? -->
129-
130-
* [ICoreWebView2ExperimentalFrameChildFrameCreatedEventHandler](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalframechildframecreatedeventhandler?view=webview2-1.0.3079-prerelease&preserve-view=true)
131-
132-
---
133-
134-
135-
<!-- ---------- -->
136-
###### Show WPF elements on top of the WebView2 layer (WebView2CompositionControl)
137-
138-
The `WebView2CompositionControl` prevents the WebView2 control from being the topmost layer in a WPF app and obscuring any WPF elements. `Microsoft.Web.WebView2.Wpf.WebView2CompositionControl` is a drop-in replacement for the standard WPF WebView2 control. Both the WebView2 control and `WebView2CompositionControl` implement the `Microsoft.Web.WebView2.Wpf.IWebView2` interface. Both of them derive from `FrameworkElement`, as follows:
139-
* `FrameworkElement` -> `HwndHost` -> `WebView2`.
140-
* `FrameworkElement` -> `Control` -> `WebView2CompositionControl`.
141-
142-
Background: If you're building a Windows Presentation Foundation (WPF) app and using the WebView2 control, you may find that your app runs into "airspace" issues, where the WebView2 control is always displayed on top, hiding any WPF elements in the same location, even if you try to specify the WPF elements to be above the WebView2 control (using visual tree order or the z-index property, for example).
143-
144-
This issue occurs because the WPF control uses the WPF `HwndHost` to host the Win32 WebView2 control, and `HwndHost` has an issue with airspace; see [Mitigating Airspace Issues In WPF Applications](https://dwayneneed.github.io/wpf/2013/02/26/mitigating-airspace-issues-in-wpf-applications.html).
145-
<!-- todo: [PR 4804: WPF Airspace - WebView2CompositionControl](https://github.com/MicrosoftEdge/WebView2Feedback/pull/4804/files) -->
146-
147-
##### [.NET/C#](#tab/dotnetcsharp)
148-
149-
* `CoreWebView2CompositionController` Class
150-
<!-- todo: add new members -->
151-
152-
##### [WinRT/C#](#tab/winrtcsharp)
153-
154-
* [CoreWebView2 Class](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true)<!-- todo: delete link to large old class -->
155-
<!-- todo: add new members? -->
156-
157-
* [CoreWebView2CompositionController Class](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2compositioncontroller?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true)
158-
<!-- todo: add new members -->
159-
160-
##### [Win32/C++](#tab/win32cpp)
161-
162-
* [ICoreWebView2ExperimentalCompositionController5]<!-- todo: link -->
163-
<!-- todo: add members of this new partial class, probably #5 -->
164-
165-
---
166-
167-
168-
<!-- ---------- -->
169-
###### Programmatically control Find operations (Find API)
83+
###### Customize the Find behavior (Find API)
17084

17185
The Find API allows you to programmatically control **Find** operations, and enables adding the following functionality to your app:
17286
* Customize **Find** options, including **Find Term**, **Case Sensitivity**,<!-- todo: actual UI labels --> **Word Matching**, **Match Highlighting**, and **Default UI Suppression**.
@@ -265,7 +179,7 @@ There are known issues with the Find API for PDF documents. When you view a PDF
265179

266180

267181
<!-- ---------- -->
268-
###### Override the default drag and drop behavior (DragStarting API)
182+
###### Customize the drag and drop behavior (DragStarting API)
269183

270184
The `DragStarting` API overrides the default drag and drop behavior when running in visual hosting mode. The `DragStarting` event notifies your app when the user starts a drag operation in the WebView2, and provides the state that's necessary to override the default WebView2 drag operation with your own logic.
271185

@@ -331,6 +245,97 @@ The `DragStarting` API overrides the default drag and drop behavior when running
331245
---
332246

333247

248+
<!-- ---------- -->
249+
###### Track navigation history for nested iframes (FrameCreatedEvent API)
250+
251+
The FrameCreatedEvent API supports nested iframes, such as recording the navigation history for a second-level iframe. Without this API, WebView2 only tracks first-level iframes, which are the direct child iframes of the main frame. Using this API, your app can subscribe to the nested iframe creation event, giving the app access to all properties, methods, and events of `CoreWebView2Frame` for the nested iframe.
252+
253+
Use this API to manage iframe tracking on a page that contains multiple levels of iframes. You can choose to track any of the following:
254+
* Only the main page and first-level iframes (the default behavior).
255+
* A partial WebView2 frames tree with specific iframes of interest.
256+
* The full WebView2 frames tree.
257+
258+
##### [.NET/C#](#tab/dotnetcsharp)
259+
260+
* [CoreWebView2Frame Class](/dotnet/api/microsoft.web.webview2.core.corewebview2frame?view=webview2-dotnet-1.0.3079-prerelease&preserve-view=true)
261+
* [CoreWebView2Frame.FrameCreated Event](/dotnet/api/microsoft.web.webview2.core.corewebview2frame.framecreated?view=webview2-dotnet-1.0.3079-prerelease&preserve-view=true)
262+
<!-- todo: .Stop Property, like WinRT has? -->
263+
264+
##### [WinRT/C#](#tab/winrtcsharp)
265+
266+
* [CoreWebView2Frame Class](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2frame?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true)
267+
* [CoreWebView2Frame.FrameCreated Event](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2frame?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true#framecreated)
268+
* [CoreWebView2Frame.Stop Property](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2frame?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true#stop)
269+
270+
##### [Win32/C++](#tab/win32cpp)
271+
272+
* [ICoreWebView2ExperimentalFrame8](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalframe8?view=webview2-1.0.3079-prerelease&preserve-view=true)
273+
* [ICoreWebView2ExperimentalFrame8::add_FrameCreated](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalframe8?view=webview2-1.0.3079-prerelease&preserve-view=true#add_framecreated)
274+
* [ICoreWebView2ExperimentalFrame8::remove_FrameCreated](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalframe8?view=webview2-1.0.3079-prerelease&preserve-view=true#remove_framecreated)
275+
<!-- todo: add Stop Property, like WinRT has? event, or property? -->
276+
277+
* [ICoreWebView2ExperimentalFrameChildFrameCreatedEventHandler](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalframechildframecreatedeventhandler?view=webview2-1.0.3079-prerelease&preserve-view=true)
278+
279+
---
280+
281+
282+
<!-- ---------- -->
283+
###### Show WPF elements on top of the WebView2 layer (WebView2CompositionControl)
284+
285+
The `WebView2CompositionControl` prevents the WebView2 control from being the topmost layer in a WPF app and obscuring any WPF elements. `Microsoft.Web.WebView2.Wpf.WebView2CompositionControl` is a drop-in replacement for the standard WPF WebView2 control. Both the WebView2 control and `WebView2CompositionControl` implement the `Microsoft.Web.WebView2.Wpf.IWebView2` interface. Both of them derive from `FrameworkElement`, as follows:
286+
* `FrameworkElement` -> `HwndHost` -> `WebView2`.
287+
* `FrameworkElement` -> `Control` -> `WebView2CompositionControl`.
288+
289+
Background: If you're building a Windows Presentation Foundation (WPF) app and using the WebView2 control, you may find that your app runs into "airspace" issues, where the WebView2 control is always displayed on top, hiding any WPF elements in the same location, even if you try to specify the WPF elements to be above the WebView2 control (using visual tree order or the z-index property, for example).
290+
291+
This issue occurs because the WPF control uses the WPF `HwndHost` to host the Win32 WebView2 control, and `HwndHost` has an issue with airspace; see [Mitigating Airspace Issues In WPF Applications](https://dwayneneed.github.io/wpf/2013/02/26/mitigating-airspace-issues-in-wpf-applications.html).
292+
<!-- todo: [PR 4804: WPF Airspace - WebView2CompositionControl](https://github.com/MicrosoftEdge/WebView2Feedback/pull/4804/files) -->
293+
294+
##### [.NET/C#](#tab/dotnetcsharp)
295+
296+
* `CoreWebView2CompositionController` Class
297+
<!-- todo: add new members -->
298+
299+
##### [WinRT/C#](#tab/winrtcsharp)
300+
301+
* [CoreWebView2 Class](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true)<!-- todo: delete link to large old class -->
302+
<!-- todo: add new members? -->
303+
304+
* [CoreWebView2CompositionController Class](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2compositioncontroller?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true)
305+
<!-- todo: add new members -->
306+
307+
##### [Win32/C++](#tab/win32cpp)
308+
309+
* [ICoreWebView2ExperimentalCompositionController5]<!-- todo: link -->
310+
<!-- todo: add members of this new partial class, probably #5 -->
311+
312+
---
313+
314+
315+
<!-- ---------- -->
316+
###### Load a WebView2 without a white flash (DefaultBackgroundColor API)
317+
318+
Prevents a white flash during loading a WebView2.
319+
320+
##### [.NET/C#](#tab/dotnetcsharp)
321+
322+
* `CoreWebView2ControllerOptions` Class:
323+
* [CoreWebView2ControllerOptions.DefaultBackgroundColor Property](/dotnet/api/microsoft.web.webview2.core.corewebview2controlleroptions.defaultbackgroundcolor?view=webview2-dotnet-1.0.3079-prerelease&preserve-view=true)
324+
325+
##### [WinRT/C#](#tab/winrtcsharp)
326+
327+
* [CoreWebView2ControllerOptions Class](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2controlleroptions?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true)
328+
* [CoreWebView2ControllerOptions.DefaultBackgroundColor Property](/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2controlleroptions?view=webview2-winrt-1.0.3079-prerelease&preserve-view=true#defaultbackgroundcolor)
329+
330+
##### [Win32/C++](#tab/win32cpp)
331+
332+
* [ICoreWebView2ExperimentalControllerOptions3](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalcontrolleroptions3?view=webview2-1.0.3079-prerelease&preserve-view=true)
333+
* [ICoreWebView2ExperimentalControllerOptions3::get_DefaultBackgroundColor](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalcontrolleroptions3?view=webview2-1.0.3079-prerelease&preserve-view=true#get_defaultbackgroundcolor)
334+
* [ICoreWebView2ExperimentalControllerOptions3::put_DefaultBackgroundColor](/microsoft-edge/webview2/reference/win32/icorewebview2experimentalcontrolleroptions3?view=webview2-1.0.3079-prerelease&preserve-view=true#put_defaultbackgroundcolor)
335+
336+
---
337+
338+
334339
<!-- ------------------------------ -->
335340
#### Promotions
336341

0 commit comments

Comments
 (0)