CoreWebView2 Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
WebView2 enables you to host web content using the latest Microsoft Edge browser and web technology.
public class CoreWebView2type CoreWebView2 = classPublic Class CoreWebView2- Inheritance
-
CoreWebView2
Properties
| BrowserProcessId |
Gets the process ID of the browser process that hosts the WebView. |
| CanGoBack |
|
| CanGoForward |
|
| ContainsFullScreenElement |
Indicates if the WebView contains a fullscreen HTML element. |
| CookieManager |
Gets the CoreWebView2CookieManager object associated with this CoreWebView2. |
| DefaultDownloadDialogCornerAlignment |
The default download dialog corner alignment. |
| DefaultDownloadDialogMargin |
The default download dialog margin relative to the WebView corner specified by DefaultDownloadDialogCornerAlignment. |
| DocumentTitle |
Gets the title for the current top-level document. |
| Environment |
Exposes the CoreWebView2Environment used to create this CoreWebView2. |
| FaviconUri |
Get the Uri as a string of the current Favicon. This will be an empty string if the page does not have a Favicon. |
| IsDefaultDownloadDialogOpen |
True if the default download dialog is currently open. |
| IsDocumentPlayingAudio |
Indicates whether any audio output from this CoreWebView2 is playing. |
| IsMuted |
Indicates whether all audio output from this CoreWebView2 is muted or not. Set to true will mute this CoreWebView2, and set to false will unmute this CoreWebView2. |
| IsSuspended |
Whether WebView is suspended. |
| MemoryUsageTargetLevel |
Desired CoreWebView2MemoryUsageTargetLevel of a WebView. |
| Profile |
The associated CoreWebView2Profile object of CoreWebView2. |
| Settings |
Gets the CoreWebView2Settings object contains various modifiable settings for the running WebView. |
| Source |
Gets the URI of the current top level document. |
| StatusBarText |
The current text of the statusbar as defined by Window.statusbar. |
Methods
| AddHostObjectToScript(String, Object) |
Adds the provided host object to script running in the WebView with the specified name. |
| AddScriptToExecuteOnDocumentCreatedAsync(String) |
Adds the provided JavaScript to a list of scripts that should be run after the global object has been created, but before the HTML document has been parsed and before any other script included by the HTML document is run. |
| AddWebResourceRequestedFilter(String, CoreWebView2WebResourceContext) |
Adds a URI and resource context filter for the WebResourceRequested event. |
| CallDevToolsProtocolMethodAsync(String, String) |
Runs an asynchronous DevToolsProtocol method. |
| CallDevToolsProtocolMethodForSessionAsync(String, String, String) |
Runs an asynchronous |
| CapturePreviewAsync(CoreWebView2CapturePreviewImageFormat, Stream) |
Captures an image of what WebView is displaying. |
| ClearServerCertificateErrorActionsAsync() |
Clears all cached decisions to proceed with TLS certificate errors from the ServerCertificateErrorDetected event for all WebView2's sharing the same session. |
| ClearVirtualHostNameToFolderMapping(String) |
Clears a host name mapping for local folder that was added by SetVirtualHostNameToFolderMapping(String, String, CoreWebView2HostResourceAccessKind). |
| CloseDefaultDownloadDialog() |
Close the default download dialog. |
| ExecuteScriptAsync(String) |
Runs JavaScript code from the |
| GetDevToolsProtocolEventReceiver(String) |
Gets a DevTools Protocol event receiver that allows you to subscribe to a DevToolsProtocol event. |
| GetFaviconAsync(CoreWebView2FaviconImageFormat) |
Get the downloaded Favicon image for the current page and copy it to the image stream. |
| GoBack() |
Navigates the WebView to the previous page in the navigation history. |
| GoForward() |
Navigates the WebView to the next page in the navigation history. |
| Navigate(String) |
Causes a navigation of the top level document to the specified URI. |
| NavigateToString(String) |
Initiates a navigation to |
| NavigateWithWebResourceRequest(CoreWebView2WebResourceRequest) |
Navigates using a constructed CoreWebView2WebResourceRequest object. |
| OpenDefaultDownloadDialog() |
Open the default download dialog. |
| OpenDevToolsWindow() |
Opens the DevTools window for the current document in the WebView. |
| OpenTaskManagerWindow() |
Opens the Browser Task Manager view as a new window in the foreground. |
| PostWebMessageAsJson(String) |
Posts the specified |
| PostWebMessageAsString(String) |
Posts a message that is a simple string rather than a JSON string representation of a JavaScript object. |
| PrintToPdfAsync(String, CoreWebView2PrintSettings) |
Print the current page to PDF asynchronously with the provided settings. |
| Reload() |
Reloads the current page. |
| RemoveHostObjectFromScript(String) |
Removes the host object specified by the name so that it is no longer accessible from JavaScript code in the WebView. |
| RemoveScriptToExecuteOnDocumentCreated(String) |
Removes the corresponding JavaScript added via AddScriptToExecuteOnDocumentCreatedAsync(String) with the specified script ID. |
| RemoveWebResourceRequestedFilter(String, CoreWebView2WebResourceContext) |
Removes a matching WebResource filter that was previously added for the WebResourceRequested event. |
| Resume() |
Resumes the WebView so that it resumes activities on the web page. |
| SetVirtualHostNameToFolderMapping(String, String, CoreWebView2HostResourceAccessKind) |
Sets a mapping between a virtual host name and a folder path to make available to web sites via that host name. |
| Stop() |
Stops all navigations and pending resource fetches. |
| TrySuspendAsync() |
An app may call this API to have the WebView2 consume less memory. |
Events
| BasicAuthenticationRequested |
BasicAuthenticationRequested event is raised when WebView encounters a Basic HTTP Authentication request as described in https://developer.mozilla.org/docs/Web/HTTP/Authentication, an NTLM authentication or a Proxy Authentication request. |
| ClientCertificateRequested |
ClientCertificateRequested is raised when WebView2 is making a request to an HTTP server that needs a client certificate for HTTP authentication. Read more about HTTP client certificates at RFC 8446 The Transport Layer Security (TLS) Protocol Version 1.3. |
| ContainsFullScreenElementChanged |
ContainsFullScreenElementChanged is raised when the ContainsFullScreenElement property changes. |
| ContentLoading |
ContentLoading is raised before any content is loaded, including scripts added with AddScriptToExecuteOnDocumentCreatedAsync(String). ContentLoading is not raised if a same page navigation occurs (such as through fragment navigations or |
| ContextMenuRequested |
ContextMenuRequested is raised when a context menu is requested by the user and the content inside WebView hasn't disabled context menus. |
| DocumentTitleChanged |
DocumentTitleChanged is raised when the DocumentTitle property changes and may be raised before or after the NavigationCompleted event. |
| DOMContentLoaded |
DOMContentLoaded is raised when the initial HTML document has been parsed. |
| DownloadStarting |
DownloadStarting is raised when a download has begun, blocking the default download dialog, but not blocking the progress of the download. |
| FaviconChanged |
Raised when the Favicon has changed. This can include when a new page is loaded and thus by default no icon is set or the icon is set for the page by DOM or JavaScript. |
| FrameCreated |
FrameCreated is raised when a new iframe is created. |
| FrameNavigationCompleted |
FrameNavigationCompleted is raised when a child frame has completely loaded ( |
| FrameNavigationStarting |
FrameNavigationStarting is raised when a child frame in the WebView requests permission to navigate to a different URI. |
| HistoryChanged |
HistoryChanged is raised for changes to joint session history, which consists of top-level and manual frame navigations. |
| IsDefaultDownloadDialogOpenChanged |
Raised when the IsDefaultDownloadDialogOpen property changes. |
| IsDocumentPlayingAudioChanged |
IsDocumentPlayingAudioChanged is raised when document starts or stops playing audio. |
| IsMutedChanged |
IsMutedChanged is raised when the mute state changes. |
| NavigationCompleted |
NavigationCompleted is raised when the WebView has completely loaded ( |
| NavigationStarting |
NavigationStarting is raised when the WebView main frame is requesting permission to navigate to a different URI. |
| NewWindowRequested |
NewWindowRequested is raised when content inside the WebView requests to open a new window, such as through |
| PermissionRequested |
PermissionRequested is raised when content in a WebView requests permission to access some privileged resources. |
| ProcessFailed |
ProcessFailed is raised when a WebView process ends unexpectedly or becomes unresponsive. |
| ScriptDialogOpening |
ScriptDialogOpening is raised when a JavaScript dialog ( |
| ServerCertificateErrorDetected |
The ServerCertificateErrorDetected event is raised when the WebView2 cannot verify server's digital certificate while loading a web page. |
| SourceChanged |
SourceChanged is raised when the Source property changes. |
| StatusBarTextChanged |
StatusBarTextChanged event is raised when the text in the Window.statusbar changes. When the event is fired use the property StatusBarText to get the current statusbar text. |
| WebMessageReceived |
WebMessageReceived is raised when the IsWebMessageEnabled setting is set and the top-level document of the WebView runs |
| WebResourceRequested |
WebResourceRequested is raised when the WebView is performing a URL request to a matching URL and resource context filter that was added with AddWebResourceRequestedFilter(String, CoreWebView2WebResourceContext). |
| WebResourceResponseReceived |
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). |
| WindowCloseRequested |
WindowCloseRequested is raised when content inside the WebView requested to close the window, such as after |