interface ICoreWebView2_2
Note
This reference is no longer being maintained. For the latest API reference, see WebView2 API Reference.
interface ICoreWebView2_2
: public ICoreWebView2
A continuation of the ICoreWebView2 interface.
Summary
| Members | Descriptions |
|---|---|
| add_DOMContentLoaded | Add an event handler for the DOMContentLoaded event. |
| add_WebResourceResponseReceived | Add an event handler for the WebResourceResponseReceived event. |
| get_CookieManager | Gets the cookie manager object associated with this ICoreWebView2. |
| get_Environment | Exposes the CoreWebView2Environment used to create this CoreWebView2. |
| NavigateWithWebResourceRequest | Navigates using a constructed WebResourceRequest object. |
| remove_DOMContentLoaded | Remove an event handler previously added with add_DOMContentLoaded. |
| remove_WebResourceResponseReceived | Remove an event handler previously added with add_WebResourceResponseReceived. |
Applies to
| Product | Introduced |
|---|---|
| WebView2 Win32 | 1.0.705.50 |
| WebView2 Win32 Prerelease | 1.0.721 |
Members
add_DOMContentLoaded
Add an event handler for the DOMContentLoaded event.
public HRESULT add_DOMContentLoaded(ICoreWebView2DOMContentLoadedEventHandler * eventHandler, EventRegistrationToken * token)
DOMContentLoaded is raised when the initial html document has been parsed. This aligns with the the document's DOMContentLoaded event in html.
// Register a handler for the DOMContentLoaded event.
// Check whether the DOM content loaded
CHECK_FAILURE(m_appWindow->GetWebView()->QueryInterface(IID_PPV_ARGS(&m_webView2)));
CHECK_FAILURE(m_webView2->add_DOMContentLoaded(
Callback<ICoreWebView2DOMContentLoadedEventHandler>(
[this](ICoreWebView2* sender, ICoreWebView2DOMContentLoadedEventArgs* args)
-> HRESULT {
m_webView->ExecuteScript(
LR"~(
let content = document.createElement("h2");
content.style.color = 'blue';
content.textContent = "This text was added by the host app";
document.body.appendChild(content);
)~",
Callback<ICoreWebView2ExecuteScriptCompletedHandler>(
[](HRESULT error, PCWSTR result) -> HRESULT { return S_OK; })
.Get());
return S_OK;
})
.Get(),
&m_DOMContentLoadedToken));
add_WebResourceResponseReceived
Add an event handler for the WebResourceResponseReceived event.
public HRESULT add_WebResourceResponseReceived(ICoreWebView2WebResourceResponseReceivedEventHandler * eventHandler, EventRegistrationToken * token)
WebResourceResponseReceived is raised when the WebView receives the response for a request for a web resource (any URI resolution performed by the WebView; such as HTTP/HTTPS, file and data requests from redirects, navigations, declarations in HTML, implicit favicon lookups, and fetch API usage in the document). The host app can use this event to view the actual request and response for a web resource. There is no guarantee about the order in which the WebView processes the response and the host app's handler runs. The app's handler will not block the WebView from processing the response.
wil::com_ptr<ICoreWebView2_2> webview2;
CHECK_FAILURE(m_appWindow->GetWebView()->QueryInterface(IID_PPV_ARGS(&webview2)));
CHECK_FAILURE(webview2->add_WebResourceResponseReceived(
Callback<ICoreWebView2WebResourceResponseReceivedEventHandler>(
[this](
ICoreWebView2* sender,
ICoreWebView2WebResourceResponseReceivedEventArgs* args) {
wil::com_ptr<ICoreWebView2WebResourceRequest> request;
CHECK_FAILURE(args->get_Request(&request));
wil::unique_cotaskmem_string uri;
CHECK_FAILURE(request->get_Uri(&uri));
if (wcscmp(uri.get(), L"https://authenticationtest.com/HTTPAuth/") == 0)
{
wil::com_ptr<ICoreWebView2HttpRequestHeaders> requestHeaders;
CHECK_FAILURE(request->get_Headers(&requestHeaders));
wil::unique_cotaskmem_string authHeaderValue;
if (requestHeaders->GetHeader(L"Authorization", &authHeaderValue) == S_OK)
{
std::wstring message(L"Authorization: ");
message += authHeaderValue.get();
MessageBox(nullptr, message.c_str(), nullptr, MB_OK);
m_appWindow->DeleteComponent(this);
}
}
return S_OK;
})
.Get(),
&m_webResourceResponseReceivedToken));
get_CookieManager
Gets the cookie manager object associated with this ICoreWebView2.
public HRESULT get_CookieManager(ICoreWebView2CookieManager ** cookieManager)
See ICoreWebView2CookieManager.
wil::com_ptr<ICoreWebView2_2> m_webview2;
CHECK_FAILURE(m_appWindow->GetWebView()->QueryInterface(IID_PPV_ARGS(&m_webview2)));
CHECK_FAILURE(m_webview2->get_CookieManager(&m_cookieManager));
get_Environment
Exposes the CoreWebView2Environment used to create this CoreWebView2.
public HRESULT get_Environment(ICoreWebView2Environment ** environment)
NavigateWithWebResourceRequest
Navigates using a constructed WebResourceRequest object.
public HRESULT NavigateWithWebResourceRequest(ICoreWebView2WebResourceRequest * request)
This lets you provide post data or additional request headers during navigation. The headers in the WebResourceRequest override headers added by WebView2 runtime except for Cookie headers. Method can only be either "GET" or "POST". Provided post data will only be sent only if the method is "POST" and the uri scheme is HTTP(S).
wil::com_ptr<ICoreWebView2Environment2> webviewEnvironment2;
CHECK_FAILURE(appWindow->GetWebViewEnvironment()->QueryInterface(
IID_PPV_ARGS(&webviewEnvironment2)));
wil::com_ptr<ICoreWebView2WebResourceRequest> webResourceRequest;
wil::com_ptr<IStream> postDataStream = SHCreateMemStream(
reinterpret_cast<const BYTE*>(postDataBytes.get()), sizeNeededForMultiByte);
// This is acts as a form submit to https://www.w3schools.com/action_page.php
CHECK_FAILURE(webviewEnvironment2->CreateWebResourceRequest(
L"https://www.w3schools.com/action_page.php", L"POST", postDataStream.get(),
L"Content-Type: application/x-www-form-urlencoded", &webResourceRequest));
wil::com_ptr<ICoreWebView2_2> webview2;
CHECK_FAILURE(m_appWindow->GetWebView()->QueryInterface(IID_PPV_ARGS(&webview2)));
CHECK_FAILURE(webview2->NavigateWithWebResourceRequest(webResourceRequest.get()));
remove_DOMContentLoaded
Remove an event handler previously added with add_DOMContentLoaded.
public HRESULT remove_DOMContentLoaded(EventRegistrationToken token)
remove_WebResourceResponseReceived
Remove an event handler previously added with add_WebResourceResponseReceived.
public HRESULT remove_WebResourceResponseReceived(EventRegistrationToken token)
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for