[FEATURE]: Frames support

[mlipok]

What feature would you like, or what problem are you facing?

We need to support frames

What's your proposed solution?

@ioa747 please add support for frames events and add event handlers function to UDF

Then I can investigate

1. how we can use this in LoadWait function
2. how to enumerate frames
3. how to switch to frame
4. how to get frame content
5. how to click in element located in specific frame

Screenshots

No response

Do you want to work on this issue/improvement?

Yes

Any additional context?

https://learn.microsoft.com/en-us/microsoft-edge/webview2/concepts/overview-features-apis?tabs=dotnetcsharp#iframes

https://learn.microsoft.com/en-us/microsoft-edge/webview2/concepts/frames?tabs=dotnetcsharp
https://stackoverflow.com/questions/66208330/does-webview2-and-or-corewebview2-expose-a-websites-frames
https://github.com/search?q=repo%3AMicrosoftEdge%2FWebView2Feedback+frame&type=issues

[mlipok]

according to:
https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2frame?view=webview2-winrt-1.0.3595.46

we need to get a CoreWebView2Frame by handling the CoreWebView2.FrameCreated event. when created put then to the list with relation to hGUI maybe with maps or arrays ?
IMHO arrays will be better.

References:
CoreWebView2.FrameCreated

CoreWebView2.Destroyed

[mlipok]

First support was added here:
https://github.com/ioa747/NetWebView2Lib/releases/tag/v2.0.0-stable

[mlipok]

We need support for getting FrameObject something like
NetWebView2Lib.WebView2Manager.GetFrame(1) >>> NetWebView2Lib.WebView2Frame >>> https://learn.microsoft.com/pl-pl/dotnet/api/microsoft.web.webview2.core.corewebview2frame?view=webview2-dotnet-1.0.3595.46

Something like:

  Local $oFrame0 = $oWebV2M.GetFrame(0)
  Local $oFrame1 = $oWebV2M.GetFrame(1)
  Local $oFrame2 = $oWebV2M.GetFrame(2)
  Local $oFrame3 = $oWebV2M.GetFrame(3)

and then support for:

AddHostObjectToScript(String, Object, IEnumerable<String>)
ExecuteScriptAsync(String)
IsDestroyed()
PostSharedBufferToScript(CoreWebView2SharedBuffer, CoreWebView2SharedBufferAccess, String)
PostWebMessageAsJson(String)
PostWebMessageAsString(String)
RemoveHostObjectFromScript(String)

[mlipok]

almost done

[mlipok]

What about CoreWebView2FrameInfo support ?
https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2frameinfo?view=webview2-winrt-1.0.3595.46

[ioa747]

I think everything is fine.

🧊 WebView2Manager (ProgId: NetWebView2Lib.WebView2Manager)

⚡ GetFrameCount

Returns the number of currently tracked iframes.
object.GetFrameCount()

⚡ GetFrameUrl

Returns the URL of the specified frame index.
object.GetFrameUrl(Index As Integer)

⚡ GetFrameName

Returns the Name attribute of the specified frame index.
object.GetFrameName(Index As Integer)

⚡ GetFrameUrls

Returns a pipe-separated string of all tracked iframe URLs.
object.GetFrameUrls()

⚡ GetFrameNames

Returns a pipe-separated string of all tracked iframe names.
object.GetFrameNames()

⚡ GetFrameHtmlSource

Asynchronously retrieves the HTML of the frame at the specified index (sent via OnMessageReceived with 'FRAME_HTML_SOURCE|Index|').
object.GetFrameHtmlSource(Index As Integer)

⚡ GetFrame

Returns a WebView2Frame COM object for the frame at the specified index. Returns Null if the index is invalid.
object.GetFrame(Index As Integer)

⚡ GetFrameById

Returns a WebView2Frame COM object for the frame matching the specified FrameId. Returns Null if not found.
object.GetFrameById(FrameId As UInt)

🔔 OnFrameCreated

Fired when a new iframe is created in the document.
object_OnFrameCreated(Sender As Object, ParentHandle As String, Frame As Object)

🔔 OnFrameDestroyed

Fired when an iframe is removed from the document.
object_OnFrameDestroyed(Sender As Object, ParentHandle As String, Frame As Object)

🔔 OnFrameNameChanged

Fired when an iframe's name attribute changes.
object_OnFrameNameChanged(Sender As Object, ParentHandle As String, Frame As Object)

🔔 OnFrameNavigationStarting

Fired when a frame starts navigating to a new URL.
object_OnFrameNavigationStarting(Sender As Object, ParentHandle As String, Frame As Object, Url As String)

🔔 OnFrameNavigationCompleted

Fired when a frame navigation has finished.
object_OnFrameNavigationCompleted(Sender As Object, ParentHandle As String, Frame As Object, IsSuccess As Boolean, WebErrorStatus As Integer)

🔔 OnFrameContentLoading

Fired when a frame starts loading content.
object_OnFrameContentLoading(Sender As Object, ParentHandle As String, Frame As Object, NavigationId As Long)

🔔 OnFrameDOMContentLoaded

Fired when a frame's DOM content is fully loaded.
object_OnFrameDOMContentLoaded(Sender As Object, ParentHandle As String, Frame As Object, NavigationId As Long)

🔔 OnFrameWebMessageReceived

Fired when a frame receives a message via window.chrome.webview.postMessage.
object_OnFrameWebMessageReceived(Sender As Object, ParentHandle As String, Frame As Object, Message As String)

🔔 OnFramePermissionRequested

Fired when a frame requests permission (e.g. Geolocation).
object_OnFramePermissionRequested(Sender As Object, ParentHandle As String, Frame As Object, Args As Object)
See OnPermissionRequested Args for property details.

🧊 WebView2Frame (ProgId: NetWebView2Lib.WebView2Frame)

🏷️ Name

Returns the name attribute of the frame.
string object.Name

🏷️ IsDestroyed

Checks if the frame is still valid and attached to the page.
bool object.IsDestroyed

🏷️ FrameId

Returns the unique identifier of the frame (assigned by the browser).
uint object.FrameId

🏷️ Source

Returns the current URL of the frame. Uses reflection-based SDK-independent retrieval.
string object.Source

⚡IsDestroyed

Description: Checks if the frame is still valid and attached to the page.
object.IsDestroyed()

⚡ExecuteScript

Type: void (Fire-and-Forget)
Description: Executes JavaScript within the context of the frame.
object.ExecuteScript(Script As String)

⚡ExecuteScriptWithResult

Type: string (Synchronous/Blocking)
Description: Executes JavaScript in the frame and waits for the result (Thread-Safe).
object.ExecuteScriptWithResult(Script As String)

⚡PostWebMessageAsJson

Sends a JSON message to the frame content.
object.PostWebMessageAsJson(Json As String)

⚡PostWebMessageAsString

Sends a plain text message to the frame content.
object.PostWebMessageAsString(Text As String)

⚡AddHostObjectToScript

Adds a host object (AutoIt object) to the frame's script environment.
object.AddHostObjectToScript(Name As String, RawObject As Object)

⚡RemoveHostObjectFromScript

Removes a host object from the frame's script environment.
object.RemoveHostObjectFromScript(Name As String)