<?xml version="1.0"?>
|
<doc>
|
<assembly>
|
<name>Microsoft.Web.WebView2.Core</name>
|
</assembly>
|
<members>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2BoundsMode">
|
<summary>Mode for how the Bounds property is interpreted in relation to the RasterizationScale property.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BoundsMode.UseRawPixels">
|
<summary>Bounds property represents raw pixels. Physical size of Webview is not impacted by RasterizationScale.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BoundsMode.UseRasterizationScale">
|
<summary>Bounds property represents logical pixels and the RasterizationScale property is used to get the physical size of the WebView.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2BrowserProcessExitKind">
|
<summary>Specifies the browser process exit type used in the
|
`ICoreWebView2BrowserProcessExitedEventArgs` interface.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowserProcessExitKind.Normal">
|
<summary>Indicates that the browser process ended normally.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowserProcessExitKind.Failed">
|
<summary>Indicates that the browser process ended unexpectedly.
|
A `ProcessFailed` event will also be sent to listening WebViews from the
|
`ICoreWebView2Environment` associated to the failed process.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds">
|
<summary>Specifies the datatype for the
|
`ICoreWebView2Profile2::ClearBrowsingData` method.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.FileSystems">
|
<summary>Specifies file systems data.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.IndexedDb">
|
<summary>Specifies data stored by the IndexedDB DOM feature.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.LocalStorage">
|
<summary>Specifies data stored by the localStorage DOM API.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.WebSql">
|
<summary>Specifies data stored by the Web SQL database DOM API.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.CacheStorage">
|
<summary>Specifies data stored by the CacheStorage DOM API.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.AllDomStorage">
|
<summary>Specifies DOM storage data, now and future. This browsing data kind is
|
inclusive of COREWEBVIEW2_BROWSING_DATA_KINDS_FILE_SYSTEMS,
|
COREWEBVIEW2_BROWSING_DATA_KINDS_INDEXED_DB,
|
COREWEBVIEW2_BROWSING_DATA_KINDS_LOCAL_STORAGE,
|
COREWEBVIEW2_BROWSING_DATA_KINDS_WEB_SQL,
|
COREWEBVIEW2_BROWSING_DATA_KINDS_SERVICE_WORKERS,
|
COREWEBVIEW2_BROWSING_DATA_KINDS_CACHE_STORAGE,
|
and some other data kinds not listed yet to keep consistent with
|
[DOM-accessible storage](https://www.w3.org/TR/clear-site-data/#storage).</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.Cookies">
|
<summary>Specifies HTTP cookies data.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.AllSite">
|
<summary>Specifies all site data, now and future. This browsing data kind
|
is inclusive of COREWEBVIEW2_BROWSING_DATA_KINDS_ALL_DOM_STORAGE and
|
COREWEBVIEW2_BROWSING_DATA_KINDS_COOKIES. New site data types
|
may be added to this data kind in the future.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.DiskCache">
|
<summary>Specifies disk cache.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.DownloadHistory">
|
<summary>Specifies download history data.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.GeneralAutofill">
|
<summary>Specifies general autofill form data.
|
This excludes password information and includes information like:
|
names, street and email addresses, phone numbers, and arbitrary input.
|
This also includes payment data.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.PasswordAutosave">
|
<summary>Specifies password autosave data.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.BrowsingHistory">
|
<summary>Specifies browsing history data.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.Settings">
|
<summary>Specifies settings data.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.AllProfile">
|
<summary>Specifies profile data that should be wiped to make it look like a new profile.
|
This does not delete account-scoped data like passwords but will remove access
|
to account-scoped data by signing the user out.
|
Specifies all profile data, now and future. New profile data types may be added
|
to this data kind in the future.
|
This browsing data kind is inclusive of COREWEBVIEW2_BROWSING_DATA_KINDS_ALL_SITE,
|
COREWEBVIEW2_BROWSING_DATA_KINDS_DISK_CACHE,
|
COREWEBVIEW2_BROWSING_DATA_KINDS_DOWNLOAD_HISTORY,
|
COREWEBVIEW2_BROWSING_DATA_KINDS_GENERAL_AUTOFILL,
|
COREWEBVIEW2_BROWSING_DATA_KINDS_PASSWORD_AUTOSAVE,
|
COREWEBVIEW2_BROWSING_DATA_KINDS_BROWSING_HISTORY, and
|
COREWEBVIEW2_BROWSING_DATA_KINDS_SETTINGS.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds.ServiceWorkers">
|
<summary>Specifies service workers registered for an origin, and clear will result in
|
termination and deregistration of them.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2CapturePreviewImageFormat">
|
<summary>Specifies the image format for the `ICoreWebView2::CapturePreview` method.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2CapturePreviewImageFormat.Png">
|
<summary>Indicates that the PNG image format is used.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2CapturePreviewImageFormat.Jpeg">
|
<summary>Indicates the JPEG image format is used.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ChannelSearchKind">
|
<summary>The channel search kind determines the order that release channels are
|
searched for during environment creation. The default behavior is to search
|
for and use the most stable channel found on the device. The order from most
|
to least stable is: WebView2 Runtime -> Beta -> Dev -> Canary. Switch the
|
order to prefer the least stable channel in order to perform pre-release
|
testing. See `COREWEBVIEW2_RELEASE_CHANNELS` for descriptions of channels.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ChannelSearchKind.MostStable">
|
<summary>Search for a release channel from most to least stable:
|
WebView2 Runtime -> Beta -> Dev -> Canary. This is the default behavior.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ChannelSearchKind.LeastStable">
|
<summary>Search for a release channel from least to most stable:
|
Canary -> Dev -> Beta -> WebView2 Runtime.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateKind">
|
<summary>Specifies the client certificate kind.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateKind.SmartCard">
|
<summary>Specifies smart card certificate.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateKind.Pin">
|
<summary>Specifies PIN certificate.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateKind.Other">
|
<summary>Specifies other certificate.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItemKind">
|
<summary>Specifies the menu item kind
|
for the `ICoreWebView2ContextMenuItem::get_Kind` method</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItemKind.Command">
|
<summary>Specifies a command menu item kind.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItemKind.CheckBox">
|
<summary>Specifies a check box menu item kind. `ContextMenuItem` objects of this kind
|
will need the `IsChecked` property to determine current state of the check box.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItemKind.Radio">
|
<summary>Specifies a radio button menu item kind. `ContextMenuItem` objects of this kind
|
will need the `IsChecked` property to determine current state of the radio button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItemKind.Separator">
|
<summary>Specifies a separator menu item kind. `ContextMenuItem` objects of this kind
|
are used to signal a visual separator with no functionality.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItemKind.Submenu">
|
<summary>Specifies a submenu menu item kind. `ContextMenuItem` objects of this kind will contain
|
a `ContextMenuItemCollection` of its children `ContextMenuItem` objects.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTargetKind">
|
<summary>Indicates the kind of context for which the context menu was created
|
for the `ICoreWebView2ContextMenuTarget::get_Kind` method.
|
This enum will always represent the active element that caused the context menu request.
|
If there is a selection with multiple images, audio and text, for example, the element that
|
the end user right clicks on within this selection will be the option represented by this enum.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTargetKind.Page">
|
<summary>Indicates that the context menu was created for the page without any additional content.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTargetKind.Image">
|
<summary>Indicates that the context menu was created for an image element.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTargetKind.SelectedText">
|
<summary>Indicates that the context menu was created for selected text.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTargetKind.Audio">
|
<summary>Indicates that the context menu was created for an audio element.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTargetKind.Video">
|
<summary>Indicates that the context menu was created for a video element.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2CookieSameSiteKind">
|
<summary>Kind of cookie SameSite status used in the ICoreWebView2Cookie interface.
|
These fields match those as specified in https://developer.mozilla.org/docs/Web/HTTP/Cookies#.
|
Learn more about SameSite cookies here: https://tools.ietf.org/html/draft-west-first-party-cookies-07</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2CookieSameSiteKind.None">
|
<summary>None SameSite type. No restrictions on cross-site requests.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2CookieSameSiteKind.Lax">
|
<summary>Lax SameSite type. The cookie will be sent with "same-site" requests, and with "cross-site" top level navigation.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2CookieSameSiteKind.Strict">
|
<summary>Strict SameSite type. The cookie will only be sent along with "same-site" requests.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2DefaultDownloadDialogCornerAlignment">
|
<summary>The default download dialog can be aligned to any of the WebView corners
|
by setting the `DefaultDownloadDialogCornerAlignment` property. The default
|
position is top-right corner.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DefaultDownloadDialogCornerAlignment.TopLeft">
|
<summary>Top-left corner of the WebView.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DefaultDownloadDialogCornerAlignment.TopRight">
|
<summary>Top-right corner of the WebView.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DefaultDownloadDialogCornerAlignment.BottomLeft">
|
<summary>Bottom-left corner of the WebView.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DefaultDownloadDialogCornerAlignment.BottomRight">
|
<summary>Bottom-right corner of the WebView.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason">
|
<summary>Reason why a download was interrupted.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.None">
|
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.FileFailed">
|
<summary>Generic file error.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.FileAccessDenied">
|
<summary>Access denied due to security restrictions.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.FileNoSpace">
|
<summary>Disk full. User should free some space or choose a different location to
|
store the file.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.FileNameTooLong">
|
<summary>Result file path with file name is too long.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.FileTooLarge">
|
<summary>File is too large for file system.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.FileMalicious">
|
<summary>Microsoft Defender Smartscreen detected a virus in the file.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.FileTransientError">
|
<summary>File was in use, too many files opened, or out of memory.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.FileBlockedByPolicy">
|
<summary>File blocked by local policy.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.FileSecurityCheckFailed">
|
<summary>Security check failed unexpectedly. Microsoft Defender SmartScreen could
|
not scan this file.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.FileTooShort">
|
<summary>Seeking past the end of a file in opening a file, as part of resuming an
|
interrupted download. The file did not exist or was not as large as
|
expected. Partially downloaded file was truncated or deleted, and download
|
will be restarted automatically.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.FileHashMismatch">
|
<summary>Partial file did not match the expected hash and was deleted. Download
|
will be restarted automatically.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.NetworkFailed">
|
<summary>Generic network error. User can retry the download manually.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.NetworkTimeout">
|
<summary>Network operation timed out.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.NetworkDisconnected">
|
<summary>Network connection lost. User can retry the download manually.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.NetworkServerDown">
|
<summary>Server has gone down. User can retry the download manually.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.NetworkInvalidRequest">
|
<summary>Network request invalid because original or redirected URI is invalid, has
|
an unsupported scheme, or is disallowed by network policy.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.ServerFailed">
|
<summary>Generic server error. User can retry the download manually.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.ServerNoRange">
|
<summary>Server does not support range requests.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.ServerBadContent">
|
<summary>Server does not have the requested data.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.ServerUnauthorized">
|
<summary>Server did not authorize access to resource.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.ServerCertificateProblem">
|
<summary>Server certificate problem.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.ServerForbidden">
|
<summary>Server access forbidden.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.ServerUnexpectedResponse">
|
<summary>Unexpected server response. Responding server may not be intended server.
|
User can retry the download manually.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.ServerContentLengthMismatch">
|
<summary>Server sent fewer bytes than the Content-Length header. Content-length
|
header may be invalid or connection may have closed. Download is treated
|
as complete unless there are
|
[strong validators](https://tools.ietf.org/html/rfc7232#section-2) present
|
to interrupt the download.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.ServerCrossOriginRedirect">
|
<summary>Unexpected cross-origin redirect.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.UserCanceled">
|
<summary>User canceled the download.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.UserShutdown">
|
<summary>User shut down the WebView. Resuming downloads that were interrupted
|
during shutdown is not yet supported.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.UserPaused">
|
<summary>User paused the download.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason.DownloadProcessCrashed">
|
<summary>WebView crashed.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2DownloadState">
|
<summary>State of the download operation.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadState.InProgress">
|
<summary>The download is in progress.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadState.Interrupted">
|
<summary>The connection with the file host was broken. The `InterruptReason` property
|
can be accessed from `ICoreWebView2DownloadOperation`. See
|
`COREWEBVIEW2_DOWNLOAD_INTERRUPT_REASON` for descriptions of kinds of
|
interrupt reasons. Host can check whether an interrupted download can be
|
resumed with the `CanResume` property on the `ICoreWebView2DownloadOperation`.
|
Once resumed, a download is in the `COREWEBVIEW2_DOWNLOAD_STATE_IN_PROGRESS` state.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2DownloadState.Completed">
|
<summary>The download completed successfully.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2FaviconImageFormat">
|
<summary>Specifies the image format to use for favicon.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2FaviconImageFormat.Png">
|
<summary>Indicates that the PNG image format is used.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2FaviconImageFormat.Jpeg">
|
<summary>Indicates the JPEG image format is used.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandleKind">
|
<summary>Kind of CoreWebView2FileSystemHandle as described in
|
[FileSystemHandle.kind](https://developer.mozilla.org/docs/Web/API/FileSystemHandle/kind).</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandleKind.File">
|
<summary>FileSystemHandle is for a file
|
[FileSystemFileHandle](https://developer.mozilla.org/docs/Web/API/FileSystemFileHandle).</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandleKind.Directory">
|
<summary>FileSystemHandle is for a directory
|
[FileSystemDirectoryHandle](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle).</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandlePermission">
|
<summary>Allowed permissions of a CoreWebView2FileSystemHandle as described in
|
[FileSystemHandle.requestPermission()](https://developer.mozilla.org/docs/Web/API/FileSystemHandle/requestPermission).</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandlePermission.ReadOnly">
|
<summary>Read-only permission for FileSystemHandle.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandlePermission.ReadWrite">
|
<summary>Read and write permissions for FileSystemHandle.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameKind">
|
<summary>Indicates the frame type used in the `ICoreWebView2FrameInfo` interface.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2FrameKind.Unknown">
|
<summary>Indicates that the frame is an unknown type frame. We may extend this enum
|
type to identify more frame kinds in the future.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2FrameKind.MainFrame">
|
<summary>Indicates that the frame is a primary main frame(webview).</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2FrameKind.Iframe">
|
<summary>Indicates that the frame is an iframe.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2FrameKind.Embed">
|
<summary>Indicates that the frame is an embed element.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2FrameKind.Object">
|
<summary>Indicates that the frame is an object element.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2HostResourceAccessKind">
|
<summary>Kind of cross origin resource access allowed for host resources during download.
|
Note that other normal access checks like same origin DOM access check and [Content
|
Security Policy](https://developer.mozilla.org/docs/Web/HTTP/CSP) still apply.
|
|
The following table illustrates the host resource cross origin access according to
|
access context and `CoreWebView2HostResourceAccessKind`.
|
|
<list type="table"><listheader><description>Cross Origin Access Context</description><description>Deny</description><description>Allow</description><description>DenyCors</description></listheader><item><description>From DOM like src of img, script or iframe element</description><description>Deny</description><description>Allow</description><description>Allow</description></item><item><description>From Script like Fetch or XMLHttpRequest</description><description>Deny</description><description>Allow</description><description>Deny</description></item></list></summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2HostResourceAccessKind.Deny">
|
<summary>All cross origin resource access is denied, including normal sub resource access
|
as src of a script or image element.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2HostResourceAccessKind.Allow">
|
<summary>All cross origin resource access is allowed, including accesses that are
|
subject to Cross-Origin Resource Sharing(CORS) check. The behavior is similar to
|
a web site sends back http header Access-Control-Allow-Origin: *.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2HostResourceAccessKind.DenyCors">
|
<summary>Cross origin resource access is allowed for normal sub resource access like
|
as src of a script or image element, while any access that subjects to CORS check
|
will be denied.
|
See [Cross-Origin Resource Sharing](https://developer.mozilla.org/docs/Web/HTTP/CORS)
|
for more information.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2KeyEventKind">
|
<summary>Specifies the key event type that triggered an `AcceleratorKeyPressed`
|
event.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2KeyEventKind.KeyDown">
|
<summary>Specifies that the key event type corresponds to window message
|
`WM_KEYDOWN`.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2KeyEventKind.KeyUp">
|
<summary>Specifies that the key event type corresponds to window message
|
`WM_KEYUP`.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2KeyEventKind.SystemKeyDown">
|
<summary>Specifies that the key event type corresponds to window message
|
`WM_SYSKEYDOWN`.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2KeyEventKind.SystemKeyUp">
|
<summary>Specifies that the key event type corresponds to window message
|
`WM_SYSKEYUP`.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2MemoryUsageTargetLevel">
|
<summary>Specifies memory usage target level of WebView.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MemoryUsageTargetLevel.Normal">
|
<summary>Specifies normal memory usage target level.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MemoryUsageTargetLevel.Low">
|
<summary>Specifies low memory usage target level.
|
Used for inactivate WebView for reduced memory consumption.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind">
|
<summary>Mouse event type used by SendMouseInput to convey the type of mouse event
|
being sent to WebView. The values of this enum align with the matching
|
WM_* window messages.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.HorizontalWheel">
|
<summary>Mouse horizontal wheel scroll event, WM_MOUSEHWHEEL.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.LeftButtonDoubleClick">
|
<summary>Left button double click mouse event, WM_LBUTTONDBLCLK.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.LeftButtonDown">
|
<summary>Left button down mouse event, WM_LBUTTONDOWN.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.LeftButtonUp">
|
<summary>Left button up mouse event, WM_LBUTTONUP.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.Leave">
|
<summary>Mouse leave event, WM_MOUSELEAVE.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.MiddleButtonDoubleClick">
|
<summary>Middle button double click mouse event, WM_MBUTTONDBLCLK.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.MiddleButtonDown">
|
<summary>Middle button down mouse event, WM_MBUTTONDOWN.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.MiddleButtonUp">
|
<summary>Middle button up mouse event, WM_MBUTTONUP.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.Move">
|
<summary>Mouse move event, WM_MOUSEMOVE.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.RightButtonDoubleClick">
|
<summary>Right button double click mouse event, WM_RBUTTONDBLCLK.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.RightButtonDown">
|
<summary>Right button down mouse event, WM_RBUTTONDOWN.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.RightButtonUp">
|
<summary>Right button up mouse event, WM_RBUTTONUP.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.Wheel">
|
<summary>Mouse wheel scroll event, WM_MOUSEWHEEL.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.XButtonDoubleClick">
|
<summary>First or second X button double click mouse event, WM_XBUTTONDBLCLK.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.XButtonDown">
|
<summary>First or second X button down mouse event, WM_XBUTTONDOWN.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.XButtonUp">
|
<summary>First or second X button up mouse event, WM_XBUTTONUP.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.NonClientRightButtonDown">
|
<summary>Mouse Right Button Down event over a nonclient area, WM_NCRBUTTONDOWN.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.NonClientRightButtonUp">
|
<summary>Mouse Right Button up event over a nonclient area, WM_NCRBUTTONUP.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventVirtualKeys">
|
<summary>Mouse event virtual keys associated with a COREWEBVIEW2_MOUSE_EVENT_KIND for
|
SendMouseInput. These values can be combined into a bit flag if more than
|
one virtual key is pressed for the event. The values of this enum align
|
with the matching MK_* mouse keys.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventVirtualKeys.None">
|
<summary>No additional keys pressed.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventVirtualKeys.LeftButton">
|
<summary>Left mouse button is down, MK_LBUTTON.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventVirtualKeys.RightButton">
|
<summary>Right mouse button is down, MK_RBUTTON.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventVirtualKeys.Shift">
|
<summary>SHIFT key is down, MK_SHIFT.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventVirtualKeys.Control">
|
<summary>CTRL key is down, MK_CONTROL.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventVirtualKeys.MiddleButton">
|
<summary>Middle mouse button is down, MK_MBUTTON.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventVirtualKeys.XButton1">
|
<summary>First X button is down, MK_XBUTTON1</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventVirtualKeys.XButton2">
|
<summary>Second X button is down, MK_XBUTTON2</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusReason">
|
<summary>Specifies the reason for moving focus.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusReason.Programmatic">
|
<summary>Specifies that the code is setting focus into WebView.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusReason.Next">
|
<summary>Specifies that the focus is moving due to Tab traversal forward.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusReason.Previous">
|
<summary>Specifies that the focus is moving due to Tab traversal backward.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2NavigationKind">
|
<summary>Specifies the navigation kind of each navigation.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2NavigationKind.Reload">
|
<summary>A navigation caused by `CoreWebView2.Reload()`, `location.reload()`, the end user
|
using F5 or other UX, or other reload mechanisms to reload the current document
|
without modifying the navigation history.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2NavigationKind.BackOrForward">
|
<summary>A navigation back or forward to a different entry in the session navigation history,
|
like via `CoreWebView2.Back()`, `location.back()`, the end user pressing Alt+Left
|
or other UX, or other mechanisms to navigate back or forward in the current
|
session navigation history.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2NavigationKind.NewDocument">
|
<summary>A navigation to another document, which can be caused by `CoreWebView2.Navigate()`,
|
`window.location.href = ...`, or other WebView2 or DOM APIs that navigate to a new URI.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionKind">
|
<summary>This enum contains values representing possible regions a given
|
point lies within. The values of this enum align with the
|
matching WM_NCHITTEST* window message return values.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionKind.Nowhere">
|
<summary>A hit test region out of bounds of the WebView2.
|
This has the same value as the Win32 HTNOWHERE</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionKind.Client">
|
<summary>A hit test region in the WebView2 which does not have the CSS style
|
`-webkit-app-region: drag` set. This is normal web content that should not be
|
considered part of the app window's title bar. This has the same value
|
as the Win32 HTCLIENT constant.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionKind.Caption">
|
<summary>A hit test region in the WebView2 which has the CSS style
|
`-webkit-app-region: drag` set. Web content should use this CSS
|
style to identify regions that should be treated like the app
|
window's title bar. This has the same value as the Win32 HTCAPTION
|
constant.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionKind.Minimize">
|
<summary>A hit test region in the Webview2 which corresponds to the minimize
|
window control button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionKind.Maximize">
|
<summary>A hit test region in the Webview2 which corresponds to the maximize
|
window control button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionKind.Close">
|
<summary>A hit test region in the Webview2 which corresponds to the close
|
window control button.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems">
|
<summary>Specifies the PDF toolbar item types used for the `ICoreWebView2Settings::put_HiddenPdfToolbarItems` method.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.None">
|
<summary>No item.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.Save">
|
<summary>The save button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.Print">
|
<summary>The print button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.SaveAs">
|
<summary>The save as button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.ZoomIn">
|
<summary>The zoom in button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.ZoomOut">
|
<summary>The zoom out button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.Rotate">
|
<summary>The rotate button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.FitPage">
|
<summary>The fit page button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.PageLayout">
|
<summary>The page layout button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.Bookmarks">
|
<summary>The bookmarks button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.PageSelector">
|
<summary>The page select button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.Search">
|
<summary>The search button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.FullScreen">
|
<summary>The full screen button.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PdfToolbarItems.MoreSettings">
|
<summary>The more settings button.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind">
|
<summary>Indicates the type of a permission request.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.UnknownPermission">
|
<summary>Indicates an unknown permission.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.Microphone">
|
<summary>Indicates permission to capture audio.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.Camera">
|
<summary>Indicates permission to capture video.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.Geolocation">
|
<summary>Indicates permission to access geolocation.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.Notifications">
|
<summary>Indicates permission to send web notifications. Apps that would like to
|
show notifications should handle `PermissionRequested` events
|
and no browser permission prompt will be shown for notification requests.
|
Note that push notifications are currently unavailable in WebView2.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.OtherSensors">
|
<summary>Indicates permission to access generic sensor. Generic Sensor covering
|
ambient-light-sensor, accelerometer, gyroscope, and magnetometer.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.ClipboardRead">
|
<summary>Indicates permission to read the system clipboard without a user gesture.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.MultipleAutomaticDownloads">
|
<summary>Indicates permission to automatically download multiple files. Permission
|
is requested when multiple downloads are triggered in quick succession.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.FileReadWrite">
|
<summary>Indicates permission to read and write to files or folders on the device.
|
Permission is requested when developers use the [File System Access API](https://developer.mozilla.org/docs/Web/API/File_System_Access_API)
|
to show the file or folder picker to the end user, and then request
|
"readwrite" permission for the user's selection.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.Autoplay">
|
<summary>Indicates permission to play audio and video automatically on sites. This
|
permission affects the autoplay attribute and play method of the audio and
|
video HTML elements, and the start method of the Web Audio API. See the
|
[Autoplay guide for media and Web Audio APIs](https://developer.mozilla.org/docs/Web/Media/Autoplay_guide) for details.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.LocalFonts">
|
<summary>Indicates permission to use fonts on the device. Permission is requested
|
when developers use the [Local Font Access API](https://wicg.github.io/local-font-access/)
|
to query the system fonts available for styling web content.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.MidiSystemExclusiveMessages">
|
<summary>Indicates permission to send and receive system exclusive messages to/from MIDI
|
(Musical Instrument Digital Interface) devices. Permission is requested
|
when developers use the [Web MIDI API](https://developer.mozilla.org/docs/Web/API/Web_MIDI_API)
|
to request access to system exclusive MIDI messages.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind.WindowManagement">
|
<summary>Indicates permission to open and place windows on the screen. Permission is
|
requested when developers use the [Multi-Screen Window Placement API](https://www.w3.org/TR/window-placement/)
|
to get screen details.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PermissionState">
|
<summary>Specifies the response to a permission request.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionState.Default">
|
<summary>Specifies that the default browser behavior is used, which normally
|
prompt users for decision.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionState.Allow">
|
<summary>Specifies that the permission request is granted.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionState.Deny">
|
<summary>Specifies that the permission request is denied.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PointerEventKind">
|
<summary>Pointer event type used by SendPointerInput to convey the type of pointer
|
event being sent to WebView. The values of this enum align with the
|
matching WM_POINTER* window messages.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PointerEventKind.Activate">
|
<summary>Corresponds to WM_POINTERACTIVATE.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PointerEventKind.Down">
|
<summary>Corresponds to WM_POINTERDOWN.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PointerEventKind.Enter">
|
<summary>Corresponds to WM_POINTERENTER.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PointerEventKind.Leave">
|
<summary>Corresponds to WM_POINTERLEAVE.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PointerEventKind.Up">
|
<summary>Corresponds to WM_POINTERUP.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PointerEventKind.Update">
|
<summary>Corresponds to WM_POINTERUPDATE.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PreferredColorScheme">
|
<summary>An enum to represent the options for WebView2 color scheme: auto, light, or dark.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PreferredColorScheme.Auto">
|
<summary>Auto color scheme.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PreferredColorScheme.Light">
|
<summary>Light color scheme.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PreferredColorScheme.Dark">
|
<summary>Dark color scheme.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintCollation">
|
<summary>Specifies the collation for a print.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintCollation.Default">
|
<summary>The default collation for a printer.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintCollation.Collated">
|
<summary>Indicate that the collation has been selected for the printed output.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintCollation.Uncollated">
|
<summary>Indicate that the collation has not been selected for the printed output.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintColorMode">
|
<summary>Specifies the color mode for a print.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintColorMode.Default">
|
<summary>The default color mode for a printer.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintColorMode.Color">
|
<summary>Indicate that the printed output will be in color.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintColorMode.Grayscale">
|
<summary>Indicate that the printed output will be in shades of gray.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintDialogKind">
|
<summary>Specifies the print dialog kind.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintDialogKind.Browser">
|
<summary>Opens the browser print preview dialog.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintDialogKind.System">
|
<summary>Opens the system print dialog.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintDuplex">
|
<summary>Specifies the duplex option for a print.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintDuplex.Default">
|
<summary>The default duplex for a printer.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintDuplex.OneSided">
|
<summary>Print on only one side of the sheet.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintDuplex.TwoSidedLongEdge">
|
<summary>Print on both sides of the sheet, flipped along the long edge.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintDuplex.TwoSidedShortEdge">
|
<summary>Print on both sides of the sheet, flipped along the short edge.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintMediaSize">
|
<summary>Specifies the media size for a print.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintMediaSize.Default">
|
<summary>The default media size for a printer.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintMediaSize.Custom">
|
<summary>Indicate custom media size that is specific to the printer.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintOrientation">
|
<summary>The orientation for printing, used by the `Orientation` property on
|
`ICoreWebView2PrintSettings`.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintOrientation.Portrait">
|
<summary>Print the page(s) in portrait orientation.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintOrientation.Landscape">
|
<summary>Print the page(s) in landscape orientation.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintStatus">
|
<summary>Indicates the status for printing.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintStatus.Succeeded">
|
<summary>Indicates that the print operation is succeeded.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintStatus.PrinterUnavailable">
|
<summary>Indicates that the printer is not available.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintStatus.OtherError">
|
<summary>Indicates that the print operation is failed.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind">
|
<summary>Specifies the process failure type used in the
|
`ICoreWebView2ProcessFailedEventArgs` interface. The values in this enum
|
make reference to the process kinds in the Chromium architecture. For more
|
information about what these processes are and what they do, see
|
[Browser Architecture - Inside look at modern web browser](https://developers.google.com/web/updates/2018/09/inside-browser-part1).</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.BrowserProcessExited">
|
<summary>Indicates that the browser process ended unexpectedly. The WebView
|
automatically moves to the Closed state. The app has to recreate a new
|
WebView to recover from this failure.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.RenderProcessExited">
|
<summary>Indicates that the main frame's render process ended unexpectedly. Any
|
subframes in the WebView will be gone too. A new render process is
|
created automatically and navigated to an error page. You can use the
|
`Reload` method to try to recover from this failure. Alternatively, you
|
can `Close` and recreate the WebView.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.RenderProcessUnresponsive">
|
<summary>Indicates that the main frame's render process is unresponsive. Renderer
|
process unresponsiveness can happen for the following reasons:
|
There is a **long-running script** being executed. For example, the
|
web content in your WebView might be performing a synchronous XHR, or have
|
entered an infinite loop. Or, the **system is busy**.
|
The `ProcessFailed` event will continue to be raised every few seconds
|
until the renderer process has become responsive again. The application
|
can consider taking action if the event keeps being raised. For example,
|
the application might show UI for the user to decide to keep waiting or
|
reload the page, or navigate away.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.FrameRenderProcessExited">
|
<summary>Indicates that a frame-only render process ended unexpectedly. The process
|
exit does not affect the top-level document, only a subset of the
|
subframes within it. The content in these frames is replaced with an error
|
page in the frame. Your application can communicate with the main frame to
|
recover content in the impacted frames, using
|
`ICoreWebView2ProcessFailedEventArgs2::FrameInfosForFailedProcess` to get
|
information about the impacted frames.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.UtilityProcessExited">
|
<summary>Indicates that a utility process ended unexpectedly. The failed process
|
is recreated automatically. Your application does **not** need to handle
|
recovery for this event, but can use `ICoreWebView2ProcessFailedEventArgs`
|
and `ICoreWebView2ProcessFailedEventArgs2` to collect information about
|
the failure, including `ProcessDescription`.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.SandboxHelperProcessExited">
|
<summary>Indicates that a sandbox helper process ended unexpectedly. This failure
|
is not fatal. Your application does **not** need to handle recovery for
|
this event, but can use `ICoreWebView2ProcessFailedEventArgs` and
|
`ICoreWebView2ProcessFailedEventArgs2` to collect information about
|
the failure.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.GpuProcessExited">
|
<summary>Indicates that the GPU process ended unexpectedly. The failed process
|
is recreated automatically. Your application does **not** need to handle
|
recovery for this event, but can use `ICoreWebView2ProcessFailedEventArgs`
|
and `ICoreWebView2ProcessFailedEventArgs2` to collect information about
|
the failure.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.PpapiPluginProcessExited">
|
<summary>Indicates that a PPAPI plugin process ended unexpectedly. This failure
|
is not fatal. Your application does **not** need to handle recovery for
|
this event, but can use `ICoreWebView2ProcessFailedEventArgs` and
|
`ICoreWebView2ProcessFailedEventArgs2` to collect information about
|
the failure, including `ProcessDescription`.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.PpapiBrokerProcessExited">
|
<summary>Indicates that a PPAPI plugin broker process ended unexpectedly. This failure
|
is not fatal. Your application does **not** need to handle recovery for
|
this event, but can use `ICoreWebView2ProcessFailedEventArgs` and
|
`ICoreWebView2ProcessFailedEventArgs2` to collect information about
|
the failure.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.UnknownProcessExited">
|
<summary>Indicates that a process of unspecified kind ended unexpectedly. Your
|
application can use `ICoreWebView2ProcessFailedEventArgs` and
|
`ICoreWebView2ProcessFailedEventArgs2` to collect information about
|
the failure.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedReason">
|
<summary>Specifies the process failure reason used in the
|
`ICoreWebView2ProcessFailedEventArgs` interface. For process failures where
|
a process has exited, it indicates the type of issue that produced the
|
process exit.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedReason.Unexpected">
|
<summary>An unexpected process failure occurred.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedReason.Unresponsive">
|
<summary>The process became unresponsive.
|
This only applies to the main frame's render process.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedReason.Terminated">
|
<summary>The process was terminated. For example, from Task Manager.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedReason.Crashed">
|
<summary>The process crashed. Most crashes will generate dumps in the location
|
indicated by `ICoreWebView2Environment11::get_FailureReportFolderPath`.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedReason.LaunchFailed">
|
<summary>The process failed to launch.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedReason.OutOfMemory">
|
<summary>The process terminated due to running out of memory.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedReason.ProfileDeleted">
|
<summary>Deprecated. This value is unused.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessKind">
|
<summary>Indicates the process type used in the ICoreWebView2ProcessInfo interface.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessKind.Browser">
|
<summary>Indicates the browser process kind.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessKind.Renderer">
|
<summary>Indicates the render process kind.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessKind.Utility">
|
<summary>Indicates the utility process kind.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessKind.SandboxHelper">
|
<summary>Indicates the sandbox helper process kind.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessKind.Gpu">
|
<summary>Indicates the GPU process kind.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessKind.PpapiPlugin">
|
<summary>Indicates the PPAPI plugin process kind.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessKind.PpapiBroker">
|
<summary>Indicates the PPAPI plugin broker process kind.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ReleaseChannels">
|
<summary>
|
Specifies the WebView2 release channel.
|
</summary><remarks>
|
Use <c>ReleaseChannels</c> and <c>ChannelSearchKind</c> on <c>CoreWebView2EnvironmentOptions</c> to control which channel the WebView2 loader searches for.
|
<list type="table"><listheader><description>Channel</description><description>Primary purpose</description><description>How often updated with new features</description></listheader><item><description>Stable (WebView2 Runtime)</description><description>Broad Deployment</description><description>Monthly</description></item><item><description>Beta</description><description>Flighting with inner rings, automated testing</description><description>Monthly</description></item><item><description>Dev</description><description>Automated testing, selfhosting to test new APIs and features</description><description>Weekly</description></item><item><description>Canary</description><description>Automated testing, selfhosting to test new APIs and features</description><description>Daily</description></item></list></remarks>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ReleaseChannels.None">
|
<summary>No release channel. Passing only this value to `ReleaseChannels` results
|
in HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND).</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ReleaseChannels.Stable">
|
<summary>The stable WebView2 Runtime that is released every 4 weeks.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ReleaseChannels.Beta">
|
<summary>The Beta release channel that is released every 4 weeks, a week before the
|
stable release.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ReleaseChannels.Dev">
|
<summary>The Dev release channel that is released weekly.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ReleaseChannels.Canary">
|
<summary>The Canary release channel that is released daily.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsKind">
|
<summary>Specifies Save As kind selection options for
|
`ICoreWebView2SaveAsUIShowingEventArgs`.
|
|
For HTML documents, we support 3 Save As kinds: HTML_ONLY, SINGLE_FILE and
|
COMPLETE. For non-HTML documents, you must use DEFAULT. MIME types of `text/html` and
|
`application/xhtml+xml` are considered HTML documents.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsKind.Default">
|
<summary>Default kind to save non-HTML content. If this kind is selected for an HTML
|
page, the behavior is the same as the `HTML_ONLY` kind.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsKind.HtmlOnly">
|
<summary>Save the page as HTML. Only the top-level document is saved, excluding
|
subresources.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsKind.SingleFile">
|
<summary>Save the page as [MHTML](https://en.wikipedia.org/wiki/MHTML).</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsKind.Complete">
|
<summary>Save the page as HTML and download the page-related source files
|
(for example: CSS, JavaScript, images, etc.) in a directory with
|
the same filename prefix.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIResult">
|
<summary>Status of a programmatic Save As call. Indicates the result
|
of the `ShowSaveAsUI` method.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIResult.Success">
|
<summary>The ShowSaveAsUI method call completed successfully. By default, the system
|
Save As dialog opens. If `SuppressDefaultDialog` is set to TRUE, the system
|
dialog is skipped.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIResult.InvalidPath">
|
<summary>Could not perform Save As because the destination file path is an invalid path.
|
|
The path is invalid when it is empty, a relative path, or a directory,
|
or when the parent path does not exist.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIResult.FileAlreadyExists">
|
<summary>Could not perform Save As because the destination file path already exists and
|
replacing files was not allowed by the `AllowReplace` property.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIResult.KindNotSupported">
|
<summary>Could not perform Save As because the `Kind` property selection is not
|
supported due to content MIME type or system limits.
|
|
See the `COREWEBVIEW2_SAVE_AS_KIND` enum for MIME type limits.
|
|
System limits include when the `HTML_ONLY` kind is selected for an error page
|
at child mode, or when the `COMPLETE` kind is selected and the WebView is
|
running in an App Container.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIResult.Cancelled">
|
<summary>Did not perform Save As because the end user cancelled or the
|
`Cancel` property on `ICoreWebView2SaveAsUIShowingEventArgs` was set to TRUE.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogKind">
|
<summary>Specifies the JavaScript dialog type used in the
|
`ICoreWebView2ScriptDialogOpeningEventHandler` interface.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogKind.Alert">
|
<summary>Indicates that the dialog uses the `window.alert` JavaScript function.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogKind.Confirm">
|
<summary>Indicates that the dialog uses the `window.confirm` JavaScript function.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogKind.Prompt">
|
<summary>Indicates that the dialog uses the `window.prompt` JavaScript function.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogKind.Beforeunload">
|
<summary>Indicates that the dialog uses the `beforeunload` JavaScript event.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ScrollbarStyle">
|
<summary>Set ScrollBar style on `ICoreWebView2EnvironmentOptions` during environment creation.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ScrollbarStyle.Default">
|
<summary>Browser default ScrollBar style</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ScrollbarStyle.FluentOverlay">
|
<summary>Window style fluent overlay scroll bar
|
Please see [Fluent UI](https://developer.microsoft.com/fluentui#/)
|
for more details on fluent UI.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ServerCertificateErrorAction">
|
<summary>Specifies the action type when server certificate error is detected to be
|
used in the `ICoreWebView2ServerCertificateErrorDetectedEventArgs`
|
interface.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ServerCertificateErrorAction.AlwaysAllow">
|
<summary>Indicates to ignore the warning and continue the request with the TLS
|
certificate. This decision is cached for the RequestUri's host and the
|
server certificate in the session.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ServerCertificateErrorAction.Cancel">
|
<summary>Indicates to reject the certificate and cancel the request.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2ServerCertificateErrorAction.Default">
|
<summary>Indicates to display the default TLS interstitial error page to user for
|
page navigations.
|
For others TLS certificate is rejected and the request is cancelled.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2SharedBufferAccess">
|
<summary>Specifies the desired access from script to `CoreWebView2SharedBuffer`.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2SharedBufferAccess.ReadOnly">
|
<summary>Script from web page only has read access to the shared buffer.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2SharedBufferAccess.ReadWrite">
|
<summary>Script from web page has read and write access to the shared buffer.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2TextDirectionKind">
|
<summary>Indicates the text direction of the notification.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2TextDirectionKind.Default">
|
<summary>Indicates that the notification text direction adopts the browser's language setting behavior.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2TextDirectionKind.LeftToRight">
|
<summary>Indicates that the notification text is left-to-right.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2TextDirectionKind.RightToLeft">
|
<summary>Indicates that the notification text is right-to-left.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2TrackingPreventionLevel">
|
<summary>Tracking prevention levels.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2TrackingPreventionLevel.None">
|
<summary>Tracking prevention is turned off.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2TrackingPreventionLevel.Basic">
|
<summary>The least restrictive level of tracking prevention. Set to this level to
|
protect against malicious trackers but allows most other trackers and
|
personalize content and ads.
|
|
See [Current tracking prevention
|
behavior](/microsoft-edge/web-platform/tracking-prevention#current-tracking-prevention-behavior)
|
for fine-grained information on what is being blocked with this level and
|
can change with different Edge versions.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2TrackingPreventionLevel.Balanced">
|
<summary>The default level of tracking prevention. Set to this level to
|
protect against social media tracking on top of malicious trackers.
|
Content and ads will likely be less personalized.
|
|
See [Current tracking prevention
|
behavior](/microsoft-edge/web-platform/tracking-prevention#current-tracking-prevention-behavior)
|
for fine-grained information on what is being blocked with this level and
|
can change with different Edge versions.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2TrackingPreventionLevel.Strict">
|
<summary>The most restrictive level of tracking prevention. Set to this level to
|
protect
|
against malicious trackers and most trackers across sites. Content and ads
|
will likely have minimal personalization.
|
|
This level blocks the most trackers but could cause some websites to not
|
behave as expected.
|
|
See [Current tracking prevention
|
behavior](/microsoft-edge/web-platform/tracking-prevention#current-tracking-prevention-behavior)
|
for fine-grained information on what is being blocked with this level and
|
can change with different Edge versions.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus">
|
<summary>Indicates the error status values for web navigations.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.Unknown">
|
<summary>Indicates that an unknown error occurred.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.CertificateCommonNameIsIncorrect">
|
<summary>Indicates that the SSL certificate common name does not match the web
|
address.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.CertificateExpired">
|
<summary>Indicates that the SSL certificate has expired.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.ClientCertificateContainsErrors">
|
<summary>Indicates that the SSL client certificate contains errors.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.CertificateRevoked">
|
<summary>Indicates that the SSL certificate has been revoked.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.CertificateIsInvalid">
|
<summary>Indicates that the SSL certificate is not valid. The certificate may not
|
match the public key pins for the host name, the certificate is signed
|
by an untrusted authority or using a weak sign algorithm, the certificate
|
claimed DNS names violate name constraints, the certificate contains a
|
weak key, the validity period of the certificate is too long, lack of
|
revocation information or revocation mechanism, non-unique host name,
|
lack of certificate transparency information, or the certificate is
|
chained to a
|
[legacy Symantec root](https://security.googleblog.com/2018/03/distrust-of-symantec-pki-immediate.html).</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.ServerUnreachable">
|
<summary>Indicates that the host is unreachable.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.Timeout">
|
<summary>Indicates that the connection has timed out.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.ErrorHttpInvalidServerResponse">
|
<summary>Indicates that the server returned an invalid or unrecognized response.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.ConnectionAborted">
|
<summary>Indicates that the connection was stopped.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.ConnectionReset">
|
<summary>Indicates that the connection was reset.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.Disconnected">
|
<summary>Indicates that the Internet connection has been lost.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.CannotConnect">
|
<summary>Indicates that a connection to the destination was not established.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.HostNameNotResolved">
|
<summary>Indicates that the provided host name was not able to be resolved.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.OperationCanceled">
|
<summary>Indicates that the operation was canceled. This status code is also used
|
in the following cases: 1) when the app cancels a navigation via NavigationStarting event.
|
2) For original navigation if the app navigates the WebView2 in a rapid succession
|
away after the load for original navigation commenced, but before it completed.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.RedirectFailed">
|
<summary>Indicates that the request redirect failed.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.UnexpectedError">
|
<summary>Indicates that an unexpected error occurred.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.ValidAuthenticationCredentialsRequired">
|
<summary>Indicates that user is prompted with a login, waiting on user action.
|
Initial navigation to a login site will always return this even if app provides
|
credential using BasicAuthenticationRequested.
|
HTTP response status code in this case is 401.
|
See status code reference here: https://developer.mozilla.org/docs/Web/HTTP/Status.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.ValidProxyAuthenticationRequired">
|
<summary>Indicates that user lacks proper authentication credentials for a proxy server.
|
HTTP response status code in this case is 407.
|
See status code reference here: https://developer.mozilla.org/docs/Web/HTTP/Status.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext">
|
<summary>Specifies the web resource request contexts.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.All">
|
<summary>Specifies all resources.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.Document">
|
<summary>Specifies a document resource.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.Stylesheet">
|
<summary>Specifies a CSS resource.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.Image">
|
<summary>Specifies an image resource.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.Media">
|
<summary>Specifies another media resource such as a video.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.Font">
|
<summary>Specifies a font resource.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.Script">
|
<summary>Specifies a script resource.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.XmlHttpRequest">
|
<summary>Specifies an XML HTTP request, Fetch and EventSource API communication.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.Fetch">
|
<summary>Specifies a Fetch API communication.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.TextTrack">
|
<summary>Specifies a TextTrack resource.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.EventSource">
|
<summary>Specifies an EventSource API communication.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.Websocket">
|
<summary>Specifies a WebSocket API communication.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.Manifest">
|
<summary>Specifies a Web App Manifest.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.SignedExchange">
|
<summary>Specifies a Signed HTTP Exchange.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.Ping">
|
<summary>Specifies a Ping request.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.CspViolationReport">
|
<summary>Specifies a CSP Violation Report.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext.Other">
|
<summary>Specifies an other resource.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds">
|
<summary>Specifies the source of `WebResourceRequested` event.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds.None">
|
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds.Document">
|
<summary>Indicates that web resource is requested from main page including dedicated workers,
|
iframes and main script for shared workers.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds.SharedWorker">
|
<summary>Indicates that web resource is requested from shared worker.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds.ServiceWorker">
|
<summary>Indicates that web resource is requested from service worker.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds.All">
|
<summary>Indicates that web resource is requested from any supported source.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2Color">
|
<summary>A value representing RGBA color (Red, Green, Blue, Alpha) for WebView2.
|
Each component takes a value from 0 to 255, with 0 being no intensity
|
and 255 being the highest intensity.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2Color.A">
|
<summary>Specifies the intensity of the Alpha ie. opacity value. 0 is transparent,
|
255 is opaque.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2Color.R">
|
<summary>Specifies the intensity of the Red color.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2Color.G">
|
<summary>Specifies the intensity of the Green color.</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2Color.B">
|
<summary>Specifies the intensity of the Blue color.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2">
|
<summary>
|
WebView2 enables you to host web content using the latest Microsoft Edge browser and web technology.</summary>
|
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.BrowserProcessId">
|
<summary>
|
Gets the process ID of the browser process that hosts the WebView.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.CanGoBack">
|
<summary><c>true</c> if the WebView is able to navigate to a previous page in the navigation history.
|
</summary><remarks>
|
If CanGoBack changes value, the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.HistoryChanged" /> event is raised.
|
</remarks><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.HistoryChanged" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.CanGoForward">
|
<summary><c>true</c> if the WebView is able to navigate to a next page in the navigation history.
|
</summary><remarks>
|
If CanGoForward changes value, the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.HistoryChanged" /> event is raised.
|
</remarks><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.HistoryChanged" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.ContainsFullScreenElement">
|
<summary>
|
Indicates if the WebView contains a fullscreen HTML element.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.DocumentTitle">
|
<summary>
|
Gets the title for the current top-level document.
|
</summary><remarks>
|
If the document has no explicit title or is otherwise empty, a default that may or may not match the URI of the document is used.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.Settings">
|
<summary>
|
Gets the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Settings" /> object contains various modifiable settings for the running WebView.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.Source">
|
<summary>
|
Gets the URI of the current top level document.
|
</summary><remarks>
|
This value potentially changes as a part of the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.SourceChanged" /> event raised for some cases such as navigating to a different site or fragment navigations. It remains the same for other types of navigations such as page refreshes or <c>history.pushState</c> with the same URL as the current page.
|
</remarks><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.SourceChanged" />
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContainsFullScreenElementChanged">
|
<summary>
|
ContainsFullScreenElementChanged is raised when the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.ContainsFullScreenElement" /> property changes.
|
</summary><remarks>
|
An HTML element inside the WebView may enter fullscreen to the size of the WebView or leave fullscreen. This event is useful when, for example, a video element requests to go fullscreen. The listener of this event may resize the WebView in response.
|
</remarks><seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.ContainsFullScreenElement" />
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContentLoading">
|
<summary>
|
ContentLoading is raised before any content is loaded, including scripts added with <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddScriptToExecuteOnDocumentCreatedAsync(System.String)" />. ContentLoading is not raised if a same page navigation occurs (such as through fragment navigations or <c>history.pushState</c> navigations).
|
</summary><remarks>
|
This operation follows the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /> and <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.SourceChanged" /> events and precedes the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.HistoryChanged" /> and <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationCompleted" /> events.
|
</remarks><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.SourceChanged" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.HistoryChanged" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationCompleted" />
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.DocumentTitleChanged">
|
<summary>
|
DocumentTitleChanged is raised when the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.DocumentTitle" /> property changes and may be raised before or after the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationCompleted" /> event.
|
</summary><seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.DocumentTitle" />
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.FrameNavigationCompleted">
|
<summary>
|
FrameNavigationCompleted is raised when a child frame has completely loaded (<c>body.onload</c> has been raised) or loading stopped with error.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.FrameNavigationStarting">
|
<summary>
|
FrameNavigationStarting is raised when a child frame in the WebView requests permission to navigate to a different URI.
|
</summary><remarks>
|
Redirects raise this operation as well, and the navigation id is the same as the original one. You may block corresponding navigations until the event handler returns.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.HistoryChanged">
|
<summary>
|
HistoryChanged is raised for changes to joint session history, which consists of top-level and manual frame navigations.
|
</summary><remarks>
|
Use HistoryChanged to verify that the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.CanGoBack" /> or <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.CanGoForward" /> value has changed. HistoryChanged is also raised for using <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.GoBack" /> or <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.GoForward" />. HistoryChanged is raised after <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.SourceChanged" /> and <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContentLoading" />. CanGoBack is false for navigations initiated through CoreWebView2Frame APIs if there has not yet been a user gesture.
|
</remarks><seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.CanGoBack" /><seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.CanGoForward" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.SourceChanged" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContentLoading" />
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationCompleted">
|
<summary>
|
NavigationCompleted is raised when the WebView has completely loaded (<c>body.onload</c> has been raised) or loading stopped with error.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting">
|
<summary>
|
NavigationStarting is raised when the WebView main frame is requesting permission to navigate to a different URI.
|
</summary><remarks>
|
Redirects raise this event as well, and the navigation id is the same as the original one. You may block corresponding navigations until the event handler returns.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.NewWindowRequested">
|
<summary>
|
NewWindowRequested is raised when content inside the WebView requests to open a new window, such as through <c>window.open()</c>.
|
</summary><remarks>
|
The app can pass a target WebView that is considered the opened window or mark the event as <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.Handled" />, in which case WebView2 does not open a window.
|
If either <c>Handled</c> or <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.NewWindow" /> properties are not set, the target content will be opened on a popup window.
|
If a deferral is not taken on the event args, scripts that resulted in the new window that are requested are blocked until the event handler returns. If a deferral is taken, then scripts are blocked until the deferral is completed.
|
|
On Hololens 2, if the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.NewWindow" /> property is not set and the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.Handled" /> property is not set to <c>true</c>, the WebView2 will navigate to the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.Uri" />.
|
If either of these properties are set, the WebView2 will not navigate to the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.Uri" /> and the the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NewWindowRequested" /> event will continue as normal.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.PermissionRequested">
|
<summary>
|
PermissionRequested is raised when content in a WebView requests permission to access some privileged resources.
|
</summary><remarks>
|
If a deferral is not taken on the event args, the subsequent scripts are blocked until the event handler returns. If a deferral is taken, the scripts are blocked until the deferral is completed.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.ProcessFailed">
|
<summary>
|
ProcessFailed is raised when a WebView process ends unexpectedly or becomes unresponsive.
|
</summary><remarks><c>ProcessFailed</c> is raised when any of the processes in the <a href="/microsoft-edge/webview2/concepts/process-model?tabs=csharp#processes-in-the-webview2-runtime">WebView2 Process Group</a> encounters one of the following conditions:
|
|
<list type="table"><listheader><term>Condition</term><description>Details</description></listheader><item><term>Unexpected exit</term><description>
|
The process indicated by the event args has exited unexpectedly (usually due to a crash). The failure might or might not be recoverable, and some failures are auto-recoverable.
|
</description></item><item><term>Unresponsiveness</term><description>
|
The process indicated by the event args has become unresponsive to user input. This is only reported for renderer processes, and will run every few seconds until the process becomes responsive again.
|
</description></item></list><b>Note:</b> When the failing process is the browser process, a <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Environment.BrowserProcessExited" /> event will run too.
|
|
Your application can use <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs" /> to identify which condition and process the event is for, and to collect diagnostics and handle recovery if necessary. For more details about which cases need to be handled by your application, see <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind" />.
|
</remarks><example>
|
:::code language="csharp" source="../code/sample/SampleApps/WebView2WpfBrowser/MainWindow.xaml.cs" id="ProcessFailed":::
|
</example>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.ScriptDialogOpening">
|
<summary>
|
ScriptDialogOpening is raised when a JavaScript dialog (<c>alert</c>, <c>confirm</c>, <c>prompt</c>, or <c>beforeunload</c>) displays for the WebView.
|
</summary><remarks>
|
This event only is raised if the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.AreDefaultScriptDialogsEnabled" /> property is set to <c>false</c>. This event suppresses dialogs or replaces default dialogs with custom dialogs.
|
|
If a deferral is not taken on the event args, the subsequent scripts are blocked until the event handler returns. If a deferral is taken, the scripts are blocked until the deferral is completed.
|
</remarks><seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.AreDefaultScriptDialogsEnabled" />
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.SourceChanged">
|
<summary>
|
SourceChanged is raised when the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.Source" /> property changes.
|
</summary><remarks>
|
SourceChanged is raised when navigating to a different site or fragment navigations. It is not raised for other types of navigations such as page refreshes or <c>history.pushState</c> with the same URL as the current page. This event is raised before <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContentLoading" /> for navigation to a new document.
|
</remarks><seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.Source" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContentLoading" />
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebMessageReceived">
|
<summary>
|
WebMessageReceived is raised when the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsWebMessageEnabled" /> setting is set and the top-level document of the WebView runs <c>window.chrome.webview.postMessage</c> or <c>window.chrome.webview.postMessageWithAdditionalObjects</c>.
|
</summary><remarks>
|
The <c>postMessage</c> function is <c>void postMessage(object)</c> where object is any object supported by JSON conversion.
|
When <c>postMessage</c> is called, the handler's Invoke method will be called with the <c>object</c> parameter <c>postMessage</c> converted to a JSON string.
|
If the same page calls <c>postMessage</c> multiple times, the corresponding <c>WebMessageReceived</c> events are guaranteed to be fired in the same order. However, if multiple frames call <c>postMessage</c>, there is no guaranteed order. In addition, <c>WebMessageReceived</c> events caused by calls to <c>postMessage</c> are not guaranteed to be sequenced with events caused by DOM APIs. For example, if the page runs
|
<code>
|
chrome.webview.postMessage("message");
|
window.open();
|
</code>
|
then the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NewWindowRequested" /> event might be fired before the <c>WebMessageReceived</c> event. If you need the <c>WebMessageReceived</c> event to happen before anything else, then in the <c>WebMessageReceived</c> handler you can post a message back to the page and have the page wait until it receives that message before continuing.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested">
|
<summary>
|
WebResourceRequested is raised when the WebView is performing a URL request to a matching URL and resource context filter that was added with <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddWebResourceRequestedFilter(System.String,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds)" />.
|
</summary><remarks>
|
At least one filter must be added for the event to be raised.
|
The web resource requested may be blocked until the event handler returns if a deferral is not taken on the event args. If a deferral is taken, then the web resource requested is blocked until the deferral is completed.
|
|
If this event is subscribed in the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NewWindowRequested" /> handler it should be called after the new window is set. For more details see <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.NewWindow" />.
|
|
This event is by default raised for file, http, and https URI schemes. This is also raised for registered custom URI schemes. See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2CustomSchemeRegistration" /> for more details.
|
</remarks><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddWebResourceRequestedFilter(System.String,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds)" />
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.WindowCloseRequested">
|
<summary>
|
WindowCloseRequested is raised when content inside the WebView requested to close the window, such as after <c>window.close()</c> is run.
|
</summary><remarks>
|
The app should close the WebView and related app window if that makes sense to the app.
|
After the first <c>window.close()</c> call, this event may not fire for any immediate back to back <c>window.close()</c> calls.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.Navigate(System.String)">
|
<summary>
|
Causes a navigation of the top level document to the specified URI.
|
</summary><param name="uri">The URI to navigate to.</param><remarks>
|
For more information, navigate to [Navigation event](/microsoft-edge/webview2/concepts/navigation-events). Note that this operation starts a navigation and the corresponding <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /> event is raised sometime after Navigate runs.
|
</remarks><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationCompleted" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.NavigateToString(System.String)">
|
<summary>
|
Initiates a navigation to <c>htmlContent</c> as source HTML of a new document.
|
</summary><param name="htmlContent">A source HTML of a new document.</param><remarks>
|
The <c>htmlContent</c> parameter may not be larger than 2 MB (2 * 1024 * 1024 bytes) in total size. The origin of the new page is <c>about:blank</c>.
|
</remarks><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.SetVirtualHostNameToFolderMapping(System.String,System.String,Microsoft.Web.WebView2.Core.CoreWebView2HostResourceAccessKind)" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationCompleted" /><example><code>
|
webView.CoreWebView2.SetVirtualHostNameToFolderMapping(
|
"appassets.example", "assets", CoreWebView2HostResourceAccessKind.DenyCors);
|
string htmlContent =
|
@"
|
<head><link rel="stylesheet" href="http://appassets.example/run.css" /></head><body><img src="http://appassets.example/grill.png" /><p><a href="http://appassets.example/winrt_test.txt"> Click me</a></p></body>
|
";
|
webview.NavigateToString(htmlContent);
|
</code></example>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddScriptToExecuteOnDocumentCreatedAsync(System.String)">
|
<summary>
|
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.
|
</summary><param name="javaScript">The JavaScript code to be run.</param><returns>A script ID that may be passed when calling <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.RemoveScriptToExecuteOnDocumentCreated(System.String)" />.</returns><remarks>
|
The injected script will apply to all future top level document and child frame navigations until removed with <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.RemoveScriptToExecuteOnDocumentCreated(System.String)" />.
|
This is applied asynchronously and you must wait for the returned IAsyncOperation to complete before you can be sure that the script is ready to execute on future navigations.
|
If the method is run in <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NewWindowRequested" /> handler, it should be called before the new window is set. For more details see <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.NewWindow" />.
|
|
Note that if an HTML document has sandboxing of some kind via [sandbox](https://developer.mozilla.org/docs/Web/HTML/Element/iframe#attr-sandbox) properties or the [Content-Security-Policy HTTP header](https://developer.mozilla.org/docs/Web/HTTP/Headers/Content-Security-Policy) this will affect the script run here. So, for example, if the <c>allow-modals</c> keyword is not set then calls to the <c>alert</c> function will be ignored.
|
</remarks><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.RemoveScriptToExecuteOnDocumentCreated(System.String)" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.RemoveScriptToExecuteOnDocumentCreated(System.String)">
|
<summary>
|
Removes the corresponding JavaScript added via <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddScriptToExecuteOnDocumentCreatedAsync(System.String)" /> with the specified script ID.
|
</summary><param name="id">The ID corresponds to the JavaScript code to be removed from the list of scripts.</param>
|
Both use <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddScriptToExecuteOnDocumentCreatedAsync(System.String)" /> and this method in <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NewWindowRequested" /> handler at the same time sometimes causes trouble. Since invalid scripts will be ignored, the script IDs you got may not be valid anymore.
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.ExecuteScriptAsync(System.String)">
|
<summary>
|
Runs JavaScript code from the <c>javaScript</c> parameter in the current top-level document rendered in the WebView.
|
</summary><param name="javaScript">The JavaScript code to be run in the current top-level document rendered in the WebView.</param><returns>A JSON encoded string that represents the result of running the provided JavaScript.</returns><remarks>
|
If the result is <c>undefined</c>, contains a reference cycle, or otherwise is not able to be encoded into JSON, the JSON <c>null</c> value is returned as the <c>"null"</c> string.
|
|
A function that has no explicit return value returns <c>undefined</c>. If the script that was run throws an unhandled exception, then the result is also <c>null</c>. This method is applied asynchronously. If the method is run after the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /> event during a navigation, the script runs in the new document when loading it, around the time <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContentLoading" /> is run. This operation works even if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsScriptEnabled" /> is set to <c>false</c>.
|
</remarks><seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsScriptEnabled" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.CapturePreviewAsync(Microsoft.Web.WebView2.Core.CoreWebView2CapturePreviewImageFormat,System.IO.Stream)">
|
<summary>
|
Captures an image of what WebView is displaying.
|
</summary><param name="imageFormat">The format of the image to be captured.</param><param name="imageStream">The stream to which the resulting image binary data is written.</param><remarks>
|
When CapturePreviewAsync finishes writing to the stream, the Invoke method on the provided handler parameter is called. This method fails if called before the first <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContentLoading" /> event. For example if this is called in the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /> event for the first navigation it will fail. For subsequent navigations, the method may not fail, but will not capture an image of a given webpage until the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContentLoading" /> event has been fired for it. Any call to this method prior to that will result in a capture of the page being navigated away from.
|
</remarks><seealso cref="T:Microsoft.Web.WebView2.Core.CoreWebView2CapturePreviewImageFormat" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.Reload">
|
<summary>
|
Reloads the current page.
|
</summary><remarks>
|
This is similar to navigating to the URI of current top level document including all navigation events firing and respecting any entries in the HTTP cache. But, the back or forward history will not be modified.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsJson(System.String)">
|
<summary>
|
Posts the specified <c>webMessageAsJson</c> to the top level document in this WebView.
|
</summary><param name="webMessageAsJson">The web message to be posted to the top level document in this WebView.</param><remarks>
|
The event args is an instance of <c>MessageEvent</c>. The <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsWebMessageEnabled" /> setting must be <c>true</c> or the message will not be sent. The event arg's <c>data</c> property of the event arg is the <c>webMessageAsJson</c> string parameter parsed as a JSON string into a JavaScript object. The event arg's <c>source</c> property of the event arg is a reference to the <c>window.chrome.webview</c> object. For information about sending messages from the HTML document in the WebView to the host, navigate to <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebMessageReceived" />. The message is sent asynchronously. If a navigation occurs before the message is posted to the page, the message is not be sent.
|
</remarks><example>
|
Runs the message event of the <c>window.chrome.webview</c> of the top-level document. JavaScript in that document may subscribe and unsubscribe to the event using the following code:
|
<code>
|
window.chrome.webview.addEventListener('message', handler)
|
window.chrome.webview.removeEventListener('message', handler)
|
</code></example><seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsWebMessageEnabled" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebMessageReceived" /><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsString(System.String)" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsString(System.String)">
|
<summary>
|
Posts a message that is a simple string rather than a JSON string representation of a JavaScript object.
|
</summary><param name="webMessageAsString">The web message to be posted to the top level document in this WebView.</param><remarks>
|
This behaves in exactly the same manner as <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsJson(System.String)" />, but the <c>data</c> property of the event arg of the <c>window.chrome.webview</c> message is a string with the same value as <c>webMessageAsString</c>. Use this instead of <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsJson(System.String)" /> if you want to communicate using simple strings rather than JSON objects.
|
</remarks><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebMessageReceived" /><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsJson(System.String)" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.CallDevToolsProtocolMethodAsync(System.String,System.String)">
|
<summary>
|
Runs an asynchronous DevToolsProtocol method.
|
</summary><param name="methodName">The full name of the method in the format <c>{domain}.{method}</c>.</param><param name="parametersAsJson">A JSON formatted string containing the parameters for the corresponding method.</param><returns>A JSON string that represents the method's return object.</returns><remarks>
|
For more information about available methods, navigate to [DevTools Protocol Viewer](https://aka.ms/DevToolsProtocolDocs). The returned task is completed when the method asynchronously completes and will return the method's return object as a JSON string. Note even though WebView2 dispatches the CDP messages in the order called, CDP method calls may be processed out of order. If you require CDP methods to run in a particular order, you should await for the previous method call.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.GoBack">
|
<summary>
|
Navigates the WebView to the previous page in the navigation history.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.GoForward">
|
<summary>
|
Navigates the WebView to the next page in the navigation history.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.GetDevToolsProtocolEventReceiver(System.String)">
|
<summary>
|
Gets a DevTools Protocol event receiver that allows you to subscribe to a DevToolsProtocol event.
|
</summary><param name="eventName">The full name of the event in the format <c>{domain}.{event}</c>.</param><returns>A Devtools Protocol event receiver.</returns><remarks>
|
For more information about DevToolsProtocol events description and event args, navigate to [DevTools Protocol Viewer](https://aka.ms/DevToolsProtocolDocs).
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.Stop">
|
<summary>
|
Stops all navigations and pending resource fetches.
|
</summary><remarks>
|
Does not stop scripts.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddHostObjectToScript(System.String,System.Object)">
|
<summary>
|
Adds the provided host object to script running in the WebView with the specified name.
|
</summary><param name="name">The name of the host object.</param><param name="rawObject">The host object to be added to script.</param><remarks>
|
Host objects are exposed as host object proxies via <c>window.chrome.webview.hostObjects.{name}</c>. Host object proxies are promises and will resolve to an object representing the host object. Only the COM visible objects/properties/methods can be accessed from script.
|
|
The app can control which part of .NET objects are exposed using <see cref="T:System.Runtime.InteropServices.ComVisibleAttribute" />.
|
|
JavaScript code in the WebView will be able to access appObject as following and then access attributes and methods of appObject.
|
|
Note that while simple types, <c>IDispatch</c> and array are supported, and <c>IUnknown</c> objects that also implement <c>IDispatch</c> are treated as <c>IDispatch</c>, generic <c>IUnknown</c>, <c>VT_DECIMAL</c>, or <c>VT_RECORD</c> variant is not supported. Remote JavaScript objects like callback functions are represented as an <c>VT_DISPATCH</c> VARIANT with the object implementing <c>IDispatch</c>. The JavaScript callback method may be invoked using DISPID_VALUE for the DISPID. Such callback method invocations will return immediately and will not wait for the JavaScript function to run and so will not provide the return value of the JavaScript function. Nested arrays are supported up to a depth of 3. Arrays of by reference types are not supported. <c>VT_EMPTY</c> and <c>VT_NULL</c> are mapped into JavaScript as <c>null</c>. In JavaScript <c>null</c> and <c>undefined</c> are mapped to <c>VT_EMPTY</c>.
|
|
Additionally, all host objects are exposed as <c>window.chrome.webview.hostObjects.sync.{name}</c>. Here the host objects are exposed as synchronous host object proxies. These are not promises and calls to functions or property access synchronously block running script waiting to communicate cross process for the host code to run. Accordingly this can result in reliability issues and it is recommended that you use the promise based asynchronous <c>window.chrome.webview.hostObjects.{name}</c> API described above.
|
|
Synchronous host object proxies and asynchronous host object proxies can both proxy the same host object. Remote changes made by one proxy will be reflected in any other proxy of that same host object whether the other proxies and synchronous or asynchronous.
|
|
While JavaScript is blocked on a synchronous call to native code, that native code is unable to call back to JavaScript. Attempts to do so will fail with <c>HRESULT_FROM_WIN32(ERROR_POSSIBLE_DEADLOCK)</c>.
|
|
Host object proxies are JavaScript Proxy objects that intercept all property get, property set, and method invocations. Properties or methods that are a part of the Function or Object prototype are run locally. Additionally any property or method in the array <c>chrome.webview.hostObjects.options.forceLocalProperties</c> will also be run locally. This defaults to including optional methods that have meaning in JavaScript like <c>toJSON</c> and <c>Symbol.toPrimitive</c>. You can add more to this array as required.
|
|
There's a method <c>chrome.webview.hostObjects.cleanupSome</c> that will best effort garbage collect host object proxies.
|
|
The <c>chrome.webview.hostObjects.options</c> object provides the ability to change some functionality of host objects.
|
|
<list type="table"><listheader><term>Options property</term><description>Details</description></listheader><item><term><c>forceLocalProperties</c></term><description>
|
This is an array of host object property names that will be run locally, instead of being called on the native host object. This defaults to <c>then</c>, <c>toJSON</c>, <c>Symbol.toString</c>, and <c>Symbol.toPrimitive</c>. You can add other properties to specify that they should be run locally on the JavaScript host object proxy.
|
</description></item><item><term><c>log</c></term><description>
|
This is a callback that will be called with debug information. For example, you can set this to <c>console.log.bind(console)</c> to have it print debug information to the console to help when troubleshooting host object usage. By default this is null.
|
</description></item><item><term><c>shouldSerializeDates</c></term><description>
|
By default this is false, and JavaScript Date objects will be sent to host objects as a string using <c>JSON.stringify</c>. You can set this property to true to have Date objects properly serialize as a <c>System.DateTime</c> when sending to the .NET host object, and have <c>System.DateTime</c> properties and return values create a JavaScript <c>Date</c> object.
|
</description></item><item><term><c>defaultSyncProxy</c></term><description>
|
When calling a method on a synchronous proxy, the result should also be a synchronous proxy. But in some cases, the sync/async context is lost (for example, when providing to native code a reference to a function, and then calling that function in native code). In these cases, the proxy will be asynchronous, unless this property is set.
|
</description></item><item><term><c>forceAsyncMethodMatches</c></term><description>
|
This is an array of regular expressions. When calling a method on a synchronous proxy, the method call will be performed asynchronously if the method name matches a string or regular expression in this array. Setting this value to <c>Async</c> will make any method that ends with Async be an asynchronous method call. If an async method doesn't match here and isn't forced to be asynchronous, the method will be invoked synchronously, blocking execution of the calling JavaScript and then returning the resolution of the promise, rather than returning a promise.
|
</description></item><item><term><c>ignoreMemberNotFoundError</c></term><description>
|
By default, an exception is thrown when attempting to get the value of a proxy property that doesn't exist on the corresponding native class. Setting this property to <c>true</c> switches the behavior to match Chakra WinRT projection (and general JavaScript) behavior of returning <c>undefined</c> with no error.
|
</description></item><item><term><c>shouldPassTypedArraysAsArrays</c></term><description>
|
By default, typed arrays are passed to the host as <c>IDispatch</c>. To instead pass typed arrays to the host as <c>array</c>, set this to <c>true</c>.
|
</description></item></list>
|
|
Host object proxies additionally have the following methods:
|
|
<list type="table"><listheader><term>Method name</term><description>Details</description></listheader><item><term><c>applyHostFunction</c>, <c>getHostProperty</c>, <c>setHostProperty</c></term><description>
|
Perform a method invocation, property get, or property set on the host object. You can use these to explicitly force a method or property to run remotely if there is a conflicting local method or property. For instance, <c>proxy.toString()</c> will run the local <c>toString</c> method on the proxy object. But <c>proxy.applyHostFunction('toString')</c> runs <c>toString</c> on the host proxied object instead.
|
</description></item><item><term><c>getLocalProperty</c>, <c>setLocalProperty</c></term><description>
|
Perform property get, or property set locally. You can use these methods to force getting or setting a property on the host object proxy itself rather than on the host object it represents. For instance, <c>proxy.unknownProperty</c> will get the property named <c>unknownProperty</c> from the host proxied object. But <c>proxy.getLocalProperty('unknownProperty')</c> will get the value of the property <c>unknownProperty</c> on the proxy object itself.
|
</description></item><item><term><c>addEventListener</c></term><description>
|
This method only exists on proxies for .NET objects. Bind the JavaScript handler to the C# event, so that the JavaScript handler can be called through the C# event. For example, <c>chrome.webview.hostObjects.sample.addEventListener('TestEvent', () => { alert('Invoked from remote');});</c> bind an anonymous JavaScript function to a C# event called 'TestEvent'. When calling <c>TestEvent?.Invoke()</c> on C# side, the JavaScript function that was just bound will be called asynchronously. It allows adding more than one handler for an event, but if the handler is already in the list of event handler, it will not be added a second time. If the host object cannot find the event with the name passed in by the <c>addEventListener</c> function or it is no public or its return type is not void, an exception will be thrown. If the count and type of C# event's parameters do not match the count and type of JavaScript handler, invoke <c>addEventListener</c> will be successful but an exception will be passed to JavaScript when invoke the event on C# side. If the host object has defined <c>addEventListener</c> function, use the defined function rather than the additionally <c>addEventListener</c> function.
|
</description></item><item><term><c>removeEventListener</c></term><description>
|
This method only exists on proxies for .NET objects. Removes a handler previously bound with <c>addEventListener()</c>. If the handler does not exist in the list of event handler, nothing will happen. If the host object cannot find the event with the name passed in by the <c>removeEventListener</c> function or it is no public, an exception will be thrown. If the host object has defined <c>removeEventListener</c> function, use the defined function rather than the additionally <c>removeEventListener</c> function.
|
</description></item><item><term><c>sync</c></term><description>
|
Asynchronous host object proxies expose a sync method which returns a promise for a synchronous host object proxy for the same host object. For example, <c>chrome.webview.hostObjects.sample.methodCall()</c> returns an asynchronous host object proxy. You can use the <c>sync</c> method to obtain a synchronous host object proxy instead:
|
<c>const syncProxy = await chrome.webview.hostObjects.sample.methodCall().sync()</c></description></item><item><term><c>async</c></term><description>
|
Synchronous host object proxies expose an async method which blocks and returns an asynchronous host object proxy for the same host object. For example, <c>chrome.webview.hostObjects.sync.sample.methodCall()</c> returns a synchronous host object proxy. Calling the <c>async</c> method on this blocks and then returns an asynchronous host object proxy for the same host object: <c>const asyncProxy = chrome.webview.hostObjects.sync.sample.methodCall().async()</c></description></item><item><term><c>then</c></term><description>
|
Asynchronous host object proxies have a then method. This allows them to be awaitable. <c>then</c> will return a promise that resolves with a representation of the host object. If the proxy represents a JavaScript literal then a copy of that is returned locally. If the proxy represents a function then a non-awaitable proxy is returned. If the proxy represents a JavaScript object with a mix of literal properties and function properties, then the a copy of the object is returned with some properties as host object proxies.
|
</description></item><item><term><c>cancelPromise</c></term><description>
|
This method attempts to cancel the fulfillment of a promised value. If the promise hasn't already been fulfilled and cancellation is supported, the promise will get rejected. <c>cancelPromise</c> supports cancellation of IAsyncOperation and IAsyncAction methods. If the promise is successfully canceled, then calling await on the promise will throw. For example, <c>chrome.webview.hostObjects.cancelPromise(promise); await promise;</c> will throw with "Promise Canceled". Once a promise has been canceled, a subsequent cancel on the same promise will throw an exception as well.
|
</description></item></list>
|
|
All other property and method invocations (other than the above Remote object proxy methods, <c>forceLocalProperties</c> list, and properties on Function and Object prototypes) are run remotely. Asynchronous host object proxies return a promise representing asynchronous completion of remotely invoking the method, or getting the property. The promise resolves after the remote operations complete and the promises resolve to the resulting value of the operation. Synchronous host object proxies work similarly but block JavaScript execution and wait for the remote operation to complete.
|
|
Setting a property on an asynchronous host object proxy works slightly differently. The set returns immediately and the return value is the value that will be set. This is a requirement of the JavaScript Proxy object. If you need to asynchronously wait for the property set to complete, use the <c>setHostProperty</c> method which returns a promise as described above. Synchronous object property set property synchronously blocks until the property is set.
|
|
Exposing host objects to script has security risk. Please follow [best practices](/microsoft-edge/webview2/concepts/security).
|
</remarks><example>
|
To create a [IDispatch](/windows/win32/api/oaidl/nn-oaidl-idispatch) implementing class in C# use the following attributes on each class you intend to expose.
|
<code>
|
// Bridge and BridgeAnotherClass are C# classes that implement IDispatch and works with AddHostObjectToScript.
|
[ClassInterface(ClassInterfaceType.AutoDual)]
|
[ComVisible(true)]
|
public class BridgeAnotherClass
|
{
|
// Sample property.
|
public string Prop { get; set; } = "Example";
|
}
|
|
[ClassInterface(ClassInterfaceType.AutoDual)]
|
[ComVisible(true)]
|
public class Bridge
|
{
|
public string Func(string param)
|
{
|
return "Example: " + param;
|
}
|
|
public BridgeAnotherClass AnotherObject { get; set; } = new BridgeAnotherClass();
|
|
// Sample indexed property.
|
[System.Runtime.CompilerServices.IndexerName("Items")]
|
public string this[int index]
|
{
|
get { return m_dictionary[index]; }
|
set { m_dictionary[index] = value; }
|
}
|
private Dictionary<int, string> m_dictionary = new Dictionary<int, string>();
|
}
|
</code>
|
Then add instances of those classes via <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddHostObjectToScript(System.String,System.Object)" />:
|
<code>
|
webView.CoreWebView2.AddHostObjectToScript("bridge", new Bridge());
|
</code>
|
And then in script you can call the methods, and access those properties of the objects added via <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddHostObjectToScript(System.String,System.Object)" />.
|
Note that `CoreWebView2.AddHostObjectToScript` only applies to the top-level document and not to frames. To add host objects to frames use `CoreWebView2Frame.AddHostObjectToScript`.
|
<code>
|
// Find added objects on the hostObjects property
|
const bridge = chrome.webview.hostObjects.bridge;
|
|
// Call a method and pass in a parameter.
|
// The result is another proxy promise so you must await to get the result.
|
console.log(await bridge.Func("testing..."));
|
|
// A property may be another object as long as its class also implements
|
// IDispatch.
|
// Getting a property also gets a proxy promise you must await.
|
const propValue = await bridge.AnotherObject.Prop;
|
console.log(propValue);
|
|
// Indexed properties
|
let index = 123;
|
bridge[index] = "test";
|
let result = await bridge[index];
|
console.log(result);
|
</code></example><seealso cref="T:System.Runtime.InteropServices.ComVisibleAttribute" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.RemoveHostObjectFromScript(System.String)">
|
<summary>
|
Removes the host object specified by the name so that it is no longer accessible from JavaScript code in the WebView.
|
</summary><param name="name">The name of the host object to be removed.</param><remarks>
|
While new access attempts are denied, if the object is already obtained by JavaScript code in the WebView, the JavaScript code continues to have access to that object. Running this method for a name that is already removed or never added fails.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.OpenDevToolsWindow">
|
<summary>
|
Opens the DevTools window for the current document in the WebView.
|
</summary><remarks>
|
Does nothing if run when the DevTools window is already open.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddWebResourceRequestedFilter(System.String,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext)">
|
<summary>
|
Warning: This method is deprecated and does not behave as expected for
|
iframes. Please use
|
<see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddWebResourceRequestedFilter(System.String,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds)" />
|
instead.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.RemoveWebResourceRequestedFilter(System.String,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext)">
|
<summary>
|
Warning: This method and `CoreWebView2.AddWebResourceRequestedFilter(string, CoreWebView2WebResourceContext)` are deprecated.
|
Please use <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddWebResourceRequestedFilter(System.String,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds)" /> and
|
<see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.RemoveWebResourceRequestedFilter(System.String,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds)" /> instead.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.BasicAuthenticationRequested">
|
<summary>
|
BasicAuthenticationRequested event is raised when WebView encounters a Basic HTTP Authentication request as described in https://developer.mozilla.org/docs/Web/HTTP/Authentication, a Digest HTTP Authentication request as described in https://developer.mozilla.org/docs/Web/HTTP/Headers/Authorization#digest, an NTLM authentication or a Proxy Authentication request.
|
</summary><remarks>
|
The host can provide a response with credentials for the authentication or cancel the request. If the host sets the Cancel property to false but does not provide either UserName or Password properties on the Response property, then WebView2 will show the default authentication challenge dialog prompt to the user.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContextMenuRequested">
|
<summary>
|
ContextMenuRequested is raised when a context menu is requested by the user and the content inside WebView hasn't disabled context menus.
|
</summary><remarks>
|
The host has the option to create their own context menu with the information provided in the event or can add items to or remove items from WebView context menu. If the host doesn't handle the event, WebView will display the default context menu.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.CallDevToolsProtocolMethodForSessionAsync(System.String,System.String,System.String)">
|
<summary>
|
Runs an asynchronous <c>DevToolsProtocol</c> method for a specific session of an attached target.
|
</summary><param name="sessionId">The sessionId for an attached target. null or empty string is treated as the session for the default target for the top page.</param><param name="methodName">The full name of the method in the format <c>{domain}.{method}</c>.</param><param name="parametersAsJson">A JSON formatted string containing the parameters for the corresponding method.</param><returns>A JSON string that represents the method's return object.</returns><remarks>
|
There could be multiple <c>DevToolsProtocol</c> targets in a WebView.
|
Besides the top level page, iframes from different origin and web workers are also separate targets.
|
Attaching to these targets allows interaction with them.
|
When the DevToolsProtocol is attached to a target, the connection is identified by a sessionId.
|
|
To use this API, you must set the <c>flatten</c> parameter to true when calling <c>Target.attachToTarget</c> or <c>Target.setAutoAttach</c><c>DevToolsProtocol</c> method.
|
Using <c>Target.setAutoAttach</c> is recommended as that would allow you to attach to dedicated worker targets, which are not discoverable via other APIs like <c>Target.getTargets</c>.
|
For more information about targets and sessions, navigate to [Chrome DevTools Protocol - Target domain]( https://chromedevtools.github.io/devtools-protocol/tot/Target).
|
|
For more information about available methods, navigate to [DevTools Protocol Viewer](https://aka.ms/DevToolsProtocolDocs). The handler's Invoke method will be called when the method asynchronously completes. Invoke will be called with the method's return object as a JSON string.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.StatusBarText">
|
<summary>
|
The current text of the statusbar as defined by [Window.statusbar](https://developer.mozilla.org/docs/Web/API/Window/statusbar).</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.StatusBarTextChanged">
|
<summary>
|
StatusBarTextChanged event is raised when the text in the [Window.statusbar](https://developer.mozilla.org/docs/Web/API/Window/statusbar) changes. When the event is fired use the property <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.StatusBarText" /> to get the current statusbar text.
|
</summary><remarks>
|
Events which cause causes can be anything from hover, url events, and others. There is not a finite list on how to cause the statusbar to change.
|
The developer must create the status bar and set the text.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.Profile">
|
<summary>
|
The associated <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Profile" /> object of <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2" />.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.ServerCertificateErrorDetected">
|
<summary>
|
The ServerCertificateErrorDetected event is raised when the WebView2 cannot verify server's digital certificate while loading a web page.
|
</summary><remarks>
|
This event will raise for all web resources and follows the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event.
|
|
If you don't handle the event, WebView2 will show the default TLS interstitial error page to the user for navigations, and for non-navigations the web request is cancelled.
|
|
Note that WebView2 before raising `ServerCertificateErrorDetected` raises a <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationCompleted" /> event with <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs.IsSuccess" /> as FALSE and any of the below WebErrorStatuses that indicate a certificate failure.
|
|
<list type="bullet"><item><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.CertificateCommonNameIsIncorrect" /></description></item><item><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.CertificateExpired" /></description></item><item><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.ClientCertificateContainsErrors" /></description></item><item><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.CertificateRevoked" /></description></item><item><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.CertificateIsInvalid" /></description></item></list>
|
|
For more details see <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs.IsSuccess" /> and handle ServerCertificateErrorDetected event or show the default TLS interstitial error page to the user according to the app needs.
|
|
WebView2 caches the response when action is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2ServerCertificateErrorAction.AlwaysAllow" /> for the RequestUri's host and the server certificate in the session and the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ServerCertificateErrorDetected" /> event won't be raised again.
|
|
To raise the event again you must clear the cache using <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.ClearServerCertificateErrorActionsAsync" />.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.ClearServerCertificateErrorActionsAsync">
|
<summary>
|
Clears all cached decisions to proceed with TLS certificate errors from the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ServerCertificateErrorDetected" /> event for all WebView2's sharing the same session.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.FaviconUri">
|
<summary>
|
Get the Uri as a string of the current Favicon. This will be an empty string if the page does not have a Favicon.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.FaviconChanged">
|
<summary>
|
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.
|
</summary><remarks>
|
The first argument is the Webview2 which saw the changed Favicon and the second is null.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.GetFaviconAsync(Microsoft.Web.WebView2.Core.CoreWebView2FaviconImageFormat)">
|
<summary>
|
Get the downloaded Favicon image for the current page and copy it to the image stream.
|
</summary><param name="format">The format to retrieve the Favicon in.</param><returns>
|
An <c>IStream</c> populated with the downloaded Favicon.
|
</returns>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintAsync(Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)">
|
<summary>
|
Print the current web page asynchronously to the specified printer with the provided settings.</summary><remarks>
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings" /> for description of settings. Passing null for <c>printSettings</c> results in default print settings used.
|
The method will return <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintStatus" /> as <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintStatus.PrinterUnavailable" /> if <c>printerName</c> doesn't match with the name of any installed printers on the user OS.
|
The method will throw ArgumentException if the caller provides invalid settings for a given printer.
|
The async Print operation completes when it finishes printing to the printer. Only one <c>Printing</c> operation can be in progress at a time. If <c>Print</c> is called while a <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintAsync(Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> or <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfAsync(System.String,Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> or <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfStreamAsync(Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> job is in progress, <see cref="T:System.Threading.Tasks.Task`1" /> throws exception. This is only for printing operation on one webview.
|
<list type="table"><listheader><description>Error</description><description>PrintStatus</description><description>Notes</description></listheader><item><description>No</description><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintStatus.Succeeded" /></description><description>Print operation succeeded.</description></item><item><description>No</description><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintStatus.PrinterUnavailable" /></description><description>If specified printer is not found or printer status is not available, offline or error state.</description></item><item><description>No</description><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintStatus.OtherError" /></description><description>Print operation is failed. </description></item><item><description>ArgumentException</description><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintStatus.OtherError" /></description><description>If the caller provides invalid settings for the specified printer.</description></item><item><description>Exception</description><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2PrintStatus.OtherError" /></description><description>Print operation is failed as printing job already in progress.</description></item></list></remarks><example>
|
:::code language="csharp" source="../code/sample/SampleApps/WebView2WpfBrowser/MainWindow.xaml.cs" id="PrintToPrinter":::
|
</example>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.ShowPrintUI(Microsoft.Web.WebView2.Core.CoreWebView2PrintDialogKind)">
|
<summary>
|
Opens the print dialog to print the current web page.
|
</summary><remarks>
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintDialogKind" /> for descriptions of print dialog kinds.
|
|
Invoking browser or system print dialog doesn't open new print dialog if it is already open.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfStreamAsync(Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)">
|
<summary>
|
Provides the Pdf data of current web page asynchronously for the provided settings.
|
</summary><remarks>
|
Stream will be rewound to the start of the pdf data.
|
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings" /> for description of settings. Passing null for <c>printSettings</c> results in default print settings used.
|
|
The async PrintToPdfStream operation completes when it finishes writing to the stream. Only one <c>Printing</c> operation can be in progress at a time. If <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfStreamAsync(Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> is called while a <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfStreamAsync(Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> or <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfAsync(System.String,Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> or <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintAsync(Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> job is in progress, the <see cref="T:System.Threading.Tasks.Task`1" /> throws an exception. This is only for printing operation on one webview.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostSharedBufferToScript(Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer,Microsoft.Web.WebView2.Core.CoreWebView2SharedBufferAccess,System.String)">
|
<summary>
|
Share a shared buffer object with script of the main frame in the WebView.
|
</summary><param name="sharedBuffer">The <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer" /> object to be shared with script.</param><param name="access">The desired <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2SharedBufferAccess" /> given to script.</param><param name="additionalDataAsJson">Additional data to be send to script. If it is not null or empty string, and it is not a valid JSON string, <see cref="T:System.ArgumentException" /> will be thrown.</param><remarks>
|
The script will receive a <c>sharedbufferreceived</c> event from chrome.webview.
|
The event arg for that event will have the following methods and properties.
|
|
<list type="table"><listheader><description>Property</description><description>Description</description></listheader><item><description><c>getBuffer()</c></description><description>A method that returns an ArrayBuffer object with the backing content from the shared buffer.</description></item><item><description><c>additionalData</c></description><description>An object as the result of parsing <c>additionalDataAsJson</c> as JSON string. This property will be <c>undefined</c> if <c>additionalDataAsJson</c> is nullptr or empty string.</description></item><item><description><c>source</c></description><description>With a value set as <c>chrome.webview</c> object.</description></item></list>
|
|
If <c>access</c> is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2SharedBufferAccess.ReadOnly" />, the script will only have read access to the buffer.
|
If the script tries to modify the content in a read only buffer, it will cause an access violation in WebView renderer process and crash the renderer process.
|
|
If the shared buffer is already closed, the API throws COMException with error code of <c>RO_E_CLOSED</c>.
|
The script code should call <c>chrome.webview.releaseBuffer</c> with the shared buffer as the parameter to release underlying resources as soon as it does not need access to the shared buffer any more.
|
|
The application can post the same shared buffer object to multiple web pages or iframes, or post to the same web page or iframe multiple times.
|
Each <c>PostSharedBufferToScript</c> will create a separate ArrayBuffer object with its own view of the memory and is separately released.
|
The underlying shared memory will be released when all the views are released.
|
|
Sharing a buffer to script has security risk. You should only share buffer with trusted site.
|
If a buffer is shared to a untrusted site, possible sensitive information could be leaked.
|
If a buffer is shared as modifiable by the script and the script modifies it in an unexpected way, it could result in corrupted data that might even crash the application.
|
|
The example code shows how to send data to script for one time read only consumption.
|
</remarks><example>
|
:::code language="csharp" source="../code/sample/SampleApps/WebView2WpfBrowser/MainWindow.xaml.cs" id="OneTimeShareBuffer":::
|
:::code language="csharp" source="../code/sample/SampleApps/WebView2WpfBrowser/assets/sharedBuffer.html" id="ShareBufferScriptCode_1":::
|
:::code language="csharp" source="../code/sample/SampleApps/WebView2WpfBrowser/assets/sharedBuffer.html" id="ShareBufferScriptCode_2":::
|
</example>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.LaunchingExternalUriScheme">
|
<summary>
|
LaunchingExternalUriScheme is raised when a navigation request is made to a URI scheme that is registered with the OS.
|
</summary><remarks>
|
The <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.LaunchingExternalUriScheme" /> event handler may suppress the default dialog or replace the default dialog with a custom dialog.
|
If a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Deferral" /> is not taken on the event args, the external URI scheme launch is blocked until the event handler returns.
|
If a deferral is taken, the external URI scheme launch is blocked until the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Deferral" /> is completed.
|
The host also has the option to cancel the URI scheme launch.
|
|
The <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /> and <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationCompleted" /> events will be raised, regardless of whether the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs.Cancel" /> property is set to <c>true</c> or <c>false</c>.
|
The <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationCompleted" /> event will be raised with the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs.IsSuccess" /> property set to <c>false</c> and the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs.WebErrorStatus" /> property set to <c>CoreWebView2WebErrorStatus.ConnectionAborted</c> regardless of whether the host sets the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2LaunchingExternalUriSchemeEventArgs.Cancel" /> property.
|
The <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.SourceChanged" />, <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContentLoading" /> and <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.HistoryChanged" /> events will not be raised for this navigation to the external URI scheme regardless of the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs.Cancel" /> property.
|
The <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.LaunchingExternalUriScheme" /> event will be raised after the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /> event and before the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationCompleted" /> event.
|
|
The default <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Settings" /> will also be updated upon navigation to an external URI scheme.
|
If a setting on the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Settings" /> interface has been changed, navigating to an external URI scheme will trigger the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Settings" /> to update.
|
|
The WebView2 may not display the default dialog based on user settings, browser settings, and whether the origin is determined as a [trustworthy origin](https://w3c.github.io/webappsec-secure-contexts#potentially-trustworthy-origin); however, the event will still be raised.
|
If the request is initiated by a cross-origin frame without a user gesture, the request will be blocked and the `LaunchingExternalUriScheme` event will not be raised.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.MemoryUsageTargetLevel">
|
<summary>
|
Desired <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2MemoryUsageTargetLevel" /> of a WebView.
|
</summary><remarks>
|
An app may set <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.MemoryUsageTargetLevel" /> to indicate desired memory consumption level of WebView.
|
Scripts will not be impacted and continue to run.
|
This is useful for inactive apps that still want to run scripts and/or keep network connections alive and therefore could not call <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.TrySuspendAsync" /> and <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.Resume" /> to reduce memory consumption.
|
These apps can set memory usage target level to <c>CoreWebView2MemoryUsageTargetLevel.Low</c> when the app becomes inactive, and set back to <c>CoreWebView2MemoryUsageTargetLevel.Normal</c> when the app becomes active.
|
|
It is not necessary to set CoreWebView2Controller's IsVisible property to false when setting the property.
|
|
It is a best effort operation to change memory usage level, and the API will return before the operation completes.
|
|
Setting the level to `CoreWebView2MemoryUsageTargetLevel.Low` could potentially cause memory for some WebView browser processes to be swapped out to disk in some circumstances. It is a best effort to reduce memory usage as much as possible.
|
If a script runs after its related memory has been swapped out, the memory will be swapped back in to ensure the script can still run, but performance might be impacted.
|
Therefore, the app should set the level back to `CoreWebView2MemoryUsageTargetLevel.Normal` when the app becomes active again. Setting memory usage target level back to normal will not happen automatically.
|
|
An app should choose to use either the combination of <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.TrySuspendAsync" /> and <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.Resume" /> or the combination of setting MemoryUsageTargetLevel to `CoreWebView2MemoryUsageTargetLevel.Low` and `CoreWebView2MemoryUsageTargetLevel.Normal`. It is not advisable to mix them.
|
Trying to set <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.MemoryUsageTargetLevel" /> while suspended will be ignored.
|
The <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.TrySuspendAsync" /> and <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.Resume" /> methods will change the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.MemoryUsageTargetLevel" />.
|
<see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.TrySuspendAsync" /> will automatically set <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.MemoryUsageTargetLevel" /> to `CoreWebView2MemoryUsageTargetLevel.Low` while <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.Resume" /> on suspended WebView will automatically set <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.MemoryUsageTargetLevel" /> to `CoreWebView2MemoryUsageTargetLevel.Normal`.
|
Calling <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.Resume" /> when the WebView is not suspended would not change <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.MemoryUsageTargetLevel" />.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.CookieManager">
|
<summary>
|
Gets the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager" /> object associated with this <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2" />.
|
</summary><seealso cref="T:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.Environment">
|
<summary>
|
Exposes the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment" /> used to create this <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2" />.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.DOMContentLoaded">
|
<summary>
|
DOMContentLoaded is raised when the initial HTML document has been parsed.
|
</summary><remarks>
|
This aligns with the the document's DOMContentLoaded event in HTML.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceResponseReceived">
|
<summary>
|
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).
|
</summary><remarks>
|
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.
|
The event args include the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequest" /> as sent by the wire and <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponse" /> received, including any additional headers added by the network stack that were not be included as part of the associated <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event, such as Authentication headers.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.NavigateWithWebResourceRequest(Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequest)">
|
<summary>
|
Navigates using a constructed <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequest" /> object.
|
</summary><param name="Request">The constructed web resource object to provide post data or additional request headers during navigation.</param><remarks>
|
The headers in the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequest" /> override headers added by WebView2 runtime except for Cookie headers. Method can only be either <c>GET</c> or <c>POST</c>. Provided post data will only be sent only if the method is <c>POST</c> and the uri scheme is <c>HTTP(S)</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.FrameId">
|
<summary>
|
The unique identifier of the main frame. It's the same kind of ID as with the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Frame.FrameId" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo.FrameId" />.
|
</summary><remarks>
|
FrameId may not be valid if <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2" /> has not done any navigation. It's safe to get this value during or after the first <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContentLoading" /> event. Otherwise, it could return the invalid frame Id <c>0</c>.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.ExecuteScriptWithResultAsync(System.String)">
|
<summary>
|
Runs JavaScript code from the <c>javaScript</c> parameter in the current top-level document rendered in the WebView, The result of the execution is returned asynchronously in the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ExecuteScriptResult" /> object which has methods and properties to obtain the successful result of script execution as well as any unhandled JavaScript exceptions.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddWebResourceRequestedFilter(System.String,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds)">
|
<summary /><param name="uri">A URI to be added to the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event.</param><param name="ResourceContext">A resource context filter to be added to the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event.</param><param name="requestSourceKinds">A mask of one or more <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds" />s.</param>
|
A web resource request with a resource context that matches this filter's resource context and a URI that matches this filter's URI wildcard string for corresponding request sources will be raised via the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event. To receive all raised events filters have to be added before main page navigation.<remarks>
|
The <c>uri</c> parameter value is a wildcard string matched against the URI of the web resource request. This is a glob style wildcard string in which a <c>*</c> matches zero or more characters and a <c>?</c> matches exactly one character. These wildcard characters can be escaped using a backslash just before the wildcard character in order to represent the literal <c>*</c> or <c>?</c>. The matching occurs over the URI as a whole string and not limiting wildcard matches to particular parts of the URI. The wildcard filter is compared to the URI after the URI has been normalized, any URI fragment has been removed, and non-ASCII hostnames have been converted to punycode. Specifying a <c>null</c> for the uri is equivalent to an empty string which matches no URIs. For more information about resource context filters, navigate to <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext" />.
|
<list type="table"><listheader><description>URI Filter String</description><description>Request URI</description><description>Match</description><description>Notes</description></listheader><item><description><c>*</c></description><description><c>https://contoso.com/a/b/c</c></description><description>Yes</description><description>A single * will match all URIs</description></item><item><description><c>*://contoso.com/*</c></description><description><c>https://contoso.com/a/b/c</c></description><description>Yes</description><description>Matches everything in contoso.com across all schemes</description></item><item><description><c>*://contoso.com/*</c></description><description><c>https://example.com/?https://contoso.com/</c></description><description>Yes</description><description>But also matches a URI with just the same text anywhere in the URI</description></item><item><description><c>example</c></description><description><c>https://contoso.com/example</c></description><description>No</description><description>The filter does not perform partial matches</description></item><item><description><c>*example</c></description><description><c>https://contoso.com/example</c></description><description>Yes</description><description>The filter matches across URI parts </description></item><item><description><c>*example</c></description><description><c>https://contoso.com/path/?example</c></description><description>Yes</description><description>The filter matches across URI parts</description></item><item><description><c>*example</c></description><description><c>https://contoso.com/path/?query#example</c></description><description>No</description><description>The filter is matched against the URI with no fragment</description></item><item><description><c>*example</c></description><description><c>https://example</c></description><description>No</description><description>The URI is normalized before filter matching so the actual URI used for comparison is <c>https://example.com/</c></description></item><item><description><c>*example/</c></description><description><c>https://example</c></description><description>Yes</description><description>Just like above, but this time the filter ends with a / just like the normalized URI</description></item><item><description><c>https://xn--qei.example/</c></description><description><c>https://❤.example/</c></description><description>Yes</description><description>Non-ASCII hostnames are normalized to punycode before wildcard comparison</description></item><item><description><c>https://❤.example/</c></description><description><c>https://xn--qei.example/</c></description><description>No</description><description>Non-ASCII hostnames are normalized to punycode before wildcard comparison</description></item></list>
|
To form the <c>requestSourceKinds</c> parameter OR operation(s) can be applied to multiple <c>CoreWebView2WebResourceRequestSourceKind</c> to create a mask representing those source kinds. API will fail with <c>E_INVALIDARG</c> if <c>requestSourceKinds</c> equals to zero. Because service workers and shared workers run separately from any one HTML document their WebResourceRequested will be raised for all CoreWebView2s that have appropriate filters added in the corresponding CoreWebView2Environment. You should only add a WebResourceRequested filter for <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds.ServiceWorker" /> or <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds.SharedWorker" /> on one CoreWebView2 to avoid handling the same WebResourceRequested event multiple times.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.RemoveWebResourceRequestedFilter(System.String,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds)">
|
<summary>Removes a matching WebResource filter that was previously added for the
|
`WebResourceRequested` event. If the same filter was added multiple
|
times, then it must be removed as many times as it was added for the
|
removal to be effective. Returns `E_INVALIDARG` for a filter that was
|
not added or is already removed.
|
If the filter was added for multiple requestSourceKinds and removed just for one of them
|
the filter remains for the non-removed requestSourceKinds.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.SaveAsUIShowing">
|
<summary></summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.ShowSaveAsUIAsync">
|
<summary>
|
Async method to programmatically trigger a Save As action for the currently loaded document.
|
</summary><remarks>
|
It opens a system modal dialog by default. If the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIShowingEventArgs.SuppressDefaultDialog" /> property is `TRUE`, the system dialog is not opened. This method can return <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIResult" />.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.ScreenCaptureStarting">
|
<summary>
|
ScreenCaptureStarting event is raised when the [Screen Capture API](https://www.w3.org/TR/screen-capture/) is requested by the user using getDisplayMedia().
|
</summary><remarks>
|
If a deferral is not taken on the event args, the subsequent scripts are blocked until the event handler returns. If a deferral is taken, the scripts are blocked until the deferral is completed.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.SaveFileSecurityCheckStarting">
|
<summary>This event will be raised during system FileTypePolicy
|
checking the dangerous file extension list.
|
|
Developers can specify their own logic for determining whether
|
to allow a particular type of file to be saved from the document origin URI.
|
Developers can also determine the save decision based on other criteria.
|
|
Here are two properties in <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2SaveFileSecurityCheckStartingEventArgs" /> to manage the decision, <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveFileSecurityCheckStartingEventArgs.CancelSave" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveFileSecurityCheckStartingEventArgs.SuppressDefaultPolicy" />.
|
Table of Properties' value and result:
|
<list type="table"><listheader><description>CancelSave</description><description>SuppressDefaultPolicy</description><description>Result</description></listheader><item><description>False</description><description>False</description><description>Perform the default policy check. It may show the security warning UI if the file extension is dangerous.</description></item><item><description>False</description><description>True</description><description>Skip the default policy check and the possible security warning. Start saving or downloading.</description></item><item><description>True</description><description>Any</description><description>Skip the default policy check and the possible security warning. Abort save or download.</description></item></list></summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.NotificationReceived">
|
<summary>Add an event handler for the `NotificationReceived` event for
|
non-persistent notifications.
|
|
If a deferral is not taken on the event args, the subsequent scripts after
|
the DOM notification creation call (i.e. `Notification()`) are blocked
|
until the event handler returns. If a deferral is taken, the scripts are
|
blocked until the deferral is completed.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.IsSuspended">
|
<summary>
|
Whether WebView is suspended.
|
</summary><remarks>
|
True when WebView is suspended, from the time when <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.TrySuspendAsync" /> has completed successfully until WebView is resumed.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.TrySuspendAsync">
|
<summary>
|
An app may call this API to have the WebView2 consume less memory.
|
</summary><remarks>
|
This is useful when a Win32 app becomes invisible, or when a Universal Windows Platform app is being suspended, during the suspended event handler before completing the suspended event.
|
|
The <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.IsVisible" /> property must be false when the API is called. Otherwise, the API throws COMException with error code of <c>HRESULT_FROM_WIN32(ERROR_INVALID_STATE)</c>.
|
|
Suspending is similar to putting a tab to sleep in the Edge browser. Suspending pauses WebView script timers and animations, minimizes CPU usage for the associated browser renderer process and allows the operating system to reuse the memory that was used by the renderer process for other processes.
|
|
Note that Suspend is best effort and considered completed successfully once the request is sent to browser renderer process. If there is a running script, the script will continue to run and the renderer process will be suspended after that script is done.
|
|
See [Sleeping Tabs FAQ](https://techcommunity.microsoft.com/t5/articles/sleeping-tabs-faq/m-p/1705434) for conditions that might prevent WebView from being suspended. In those situations, the result of the async task is false.
|
|
The WebView will be automatically resumed when it becomes visible. Therefore, the app normally does not have to call <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.Resume" /> explicitly.
|
|
The app can call <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.Resume" /> and then <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.TrySuspendAsync" /> periodically for an invisible WebView so that the invisible WebView can sync up with latest data and the page ready to show fresh content when it becomes visible.
|
|
All WebView APIs can still be accessed when a WebView is suspended. Some APIs like Navigate will auto resume the WebView. To avoid unexpected auto resume, check <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.IsSuspended" /> property before calling APIs that might change WebView state.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.Resume">
|
<summary>
|
Resumes the WebView so that it resumes activities on the web page.
|
</summary><remarks>
|
This API can be called while the WebView2 controller is invisible.
|
|
The app can interact with the WebView immediately after <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.Resume" />.
|
|
WebView will be automatically resumed when it becomes visible.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.SetVirtualHostNameToFolderMapping(System.String,System.String,Microsoft.Web.WebView2.Core.CoreWebView2HostResourceAccessKind)">
|
<summary>
|
Sets a mapping between a virtual host name and a folder path to make available to web sites via that host name.
|
</summary><param name="hostName">A virtual host name.</param><param name="folderPath">A folder path name to be mapped to the virtual host name. The length must not exceed the Windows MAX_PATH limit.</param><param name="accessKind">The level of access to resources under the virtual host from other sites.</param><remarks><para>
|
After setting the mapping, documents loaded in the WebView can use HTTP or HTTPS URLs at the specified host name specified by <c>hostName</c> to access files in the local folder specified by <c>folderPath</c>.
|
This mapping applies to both top-level document and iframe navigations as well as subresource references from a document. This also applies to dedicated and shared worker scripts but does not apply to service worker scripts.
|
|
Due to a current implementation limitation, media files accessed using virtual host name can be very slow to load.
|
|
As the resource loaders for the current page might have already been created and running, changes to the mapping might not be applied to the current page and a reload of the page is needed to apply the new mapping.
|
|
Both absolute and relative paths are supported for <c>folderPath</c>. Relative paths are interpreted as relative to the folder where the exe of the app is in.
|
</para><para>
|
For example, after calling <c>SetVirtualHostNameToFolderMapping("appassets.example", "assets", CoreWebView2HostResourceAccessKind.Deny);</c>, navigating to <c>https://appassets.example/my-local-file.html</c> will show content from my-local-file.html in the assets subfolder located on disk under the same path as the app's executable file.
|
|
DOM elements that want to reference local files will have their host reference virtual host in the source. If there are multiple folders being used, define one unique virtual host per folder.
|
</para><para>
|
You should typically choose virtual host names that are never used by real sites.
|
If you own a domain such as <c>example.com</c>, another option is to use a subdomain reserved for the app (like <c>my-app.example.com</c>).
|
</para><para>
|
[RFC 6761](https://tools.ietf.org/html/rfc6761) has reserved several special-use domain names that are guaranteed to not be used by real sites (for example, <c>.example</c>, <c>.test</c>, and <c>.invalid</c>).
|
</para><para>
|
Note that using <c>.local</c> as the top-level domain name will work but can cause a delay during navigations. You should avoid using <c>.local</c> if you can.
|
</para><para>
|
Apps should use distinct domain names when mapping folder from different sources that should be isolated from each other. For instance, the app might use app-file.example for files that ship as part of the app, and book1.example might be used for files containing books from a less trusted source that were previously downloaded and saved to the disk by the app.
|
</para><para>
|
The host name used in the APIs is canonicalized using Chromium's host name parsing logic before being used internally.
|
For more information see [HTML5 2.6 URLs](https://dev.w3.org/html5/spec-LC/urls.html).
|
</para><para>
|
All host names that are canonicalized to the same string are considered identical.
|
For example, <c>EXAMPLE.COM</c> and <c>example.com</c> are treated as the same host name.
|
An international host name and its Punycode-encoded host name are considered the same host name. There is no DNS resolution for host name and the trailing '.' is not normalized as part of canonicalization.
|
</para><para>
|
Therefore <c>example.com</c> and <c>example.com.</c> are treated as different host names. Similarly, <c>virtual-host-name</c> and <c>virtual-host-name.example.com</c> are treated as different host names even if the machine has a DNS suffix of <c>example.com</c>.
|
</para><para>
|
Specify the minimal cross-origin access necessary to run the app. If there is not a need to access local resources from other origins, use <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2HostResourceAccessKind.Deny" />.
|
</para></remarks><example><code>
|
webView.CoreWebView2.SetVirtualHostNameToFolderMapping(
|
"appassets.example", "assets", CoreWebView2HostResourceAccessKind.DenyCors);
|
webView.Source = new Uri("https://appassets.example/index.html");
|
</code>
|
|
This in an example on how to embed a local image. For more information see <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.NavigateToString(System.String)" />.
|
<code>
|
webView.CoreWebView2.SetVirtualHostNameToFolderMapping(
|
"appassets.example", "assets", CoreWebView2HostResourceAccessKind.DenyCors);
|
string c_navString = "<img src="http://appassets.example/wv2.png" />";
|
webview.NavigateToString(c_navString);
|
</code></example><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.ClearVirtualHostNameToFolderMapping(System.String)" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.ClearVirtualHostNameToFolderMapping(System.String)">
|
<summary>
|
Clears a host name mapping for local folder that was added by <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.SetVirtualHostNameToFolderMapping(System.String,System.String,Microsoft.Web.WebView2.Core.CoreWebView2HostResourceAccessKind)" />.
|
</summary><param name="hostName">The host name to be removed from the mapping.</param><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.SetVirtualHostNameToFolderMapping(System.String,System.String,Microsoft.Web.WebView2.Core.CoreWebView2HostResourceAccessKind)" />
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.DownloadStarting">
|
<summary>
|
DownloadStarting is raised when a download has begun, blocking the default download dialog, but not blocking the progress of the download.
|
</summary><remarks>
|
The host can choose to cancel a download, change the result file path, and hide the default download dialog. If download is not handled or canceled, the download is saved to the default path after the event completes with default download dialog shown.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.FrameCreated">
|
<summary>
|
FrameCreated is raised when a new iframe is created. Handle this event to get access to <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Frame" /> objects.
|
</summary><seealso cref="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameCreatedEventArgs" /><remarks>
|
Use the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.Destroyed" /> to listen for when this iframe goes away.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.ClientCertificateRequested">
|
<summary>
|
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](https://tools.ietf.org/html/rfc8446).
|
</summary><remarks>
|
The host have several options for responding to client certificate requests:
|
|
<list type="table"><listheader><description>Scenario</description><description>Handled</description><description>Cancel</description><description>SelectedCertificate</description></listheader><item><description>Respond to server with a certificate</description><description>True</description><description>False</description><description>MutuallyTrustedCertificate value</description></item><item><description>Respond to server without certificate</description><description>True</description><description>False</description><description>null</description></item><item><description>Display default client certificate selection dialog prompt</description><description>False</description><description>False</description><description>n/a</description></item><item><description>Cancel the request</description><description>n/a</description><description>True</description><description>n/a</description></item></list>
|
|
If the host don't handle the event, WebView2 will show the default client certificate selection dialog prompt to the user.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.OpenTaskManagerWindow">
|
<summary>
|
Opens the Browser Task Manager view as a new window in the foreground.
|
</summary><remarks>
|
If the Browser Task Manager is already open, this will bring it into the foreground. WebView2 currently blocks the Shift+Esc shortcut for opening the task manager. An end user can open the browser task manager manually via the <c>Browser task manager</c> entry of the DevTools window's title bar's context menu.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfAsync(System.String,Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)">
|
<summary>
|
Print the current page to PDF asynchronously with the provided settings.
|
</summary><remarks>
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings" /> for description of settings. Passing null for <c>printSettings</c> results in default print settings used.
|
|
Use <c>resultFilePath</c> to specify the path to the PDF file. The host should provide an absolute path, including file name. If the path points to an existing file, the file will be overwritten. If the path is not valid, the method fails.
|
|
The async PrintToPdf operation completes when the data has been written to the PDF file. If the application exits before printing is complete, the file is not saved. Only one PrintToPdf operation can be in progress at a time.
|
If PrintToPdf is called while a print to PDF operation is in progress, the IAsyncOperation completes and returns false.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.IsDocumentPlayingAudio">
|
<summary>
|
Indicates whether any audio output from this CoreWebView2 is playing. <c>true</c> if audio is playing even if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.IsMuted" /> is true.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.IsMuted">
|
<summary>
|
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. <c>true</c> if audio is muted.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.IsDocumentPlayingAudioChanged">
|
<summary>
|
IsDocumentPlayingAudioChanged is raised when document starts or stops playing audio.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.IsMutedChanged">
|
<summary>
|
IsMutedChanged is raised when the mute state changes.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.DefaultDownloadDialogCornerAlignment">
|
<summary>
|
The default download dialog corner alignment.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.DefaultDownloadDialogMargin">
|
<summary>
|
The default download dialog margin relative to the WebView corner specified by <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.DefaultDownloadDialogCornerAlignment" />.
|
</summary><remarks>
|
The margin is a point that describes the vertical and horizontal distances between the chosen WebView corner and the default download dialog corner nearest to it. Positive values move the dialog towards the center of the WebView from the chosen WebView corner, and negative values move the dialog away from it. Use (0, 0) to align the dialog to the WebView corner with no margin. The corner alignment and margin should be set during initialization to ensure that they are correctly applied when the layout is first computed, otherwise they will not take effect until the next time the WebView position or size is updated.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2.IsDefaultDownloadDialogOpen">
|
<summary>
|
True if the default download dialog is currently open.
|
</summary><remarks>
|
The value of this property changes only when the default download dialog is explicitly opened or closed. Hiding the WebView implicitly hides the dialog, but does not change the value of this property.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2.IsDefaultDownloadDialogOpenChanged">
|
<summary>
|
Raised when the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.IsDefaultDownloadDialogOpen" /> property changes.
|
</summary><remarks>
|
This event comes after the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.DownloadStarting" /> event. Setting the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadStartingEventArgs.Handled" /> property disables the default download dialog and ensures that this event is never raised.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.OpenDefaultDownloadDialog">
|
<summary>
|
Open the default download dialog.
|
</summary><remarks>
|
If the dialog is opened before there are recent downloads, the dialog shows all past downloads for the current profile. Otherwise, the dialog shows only the recent downloads with a "See more" button for past downloads. Calling this method raises the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.IsDefaultDownloadDialogOpenChanged" /> event if the dialog was closed. No effect if the dialog is already open.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.CloseDefaultDownloadDialog">
|
<summary>
|
Close the default download dialog.
|
</summary><remarks>
|
Calling this method raises the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.IsDefaultDownloadDialogOpenChanged" /> event if the dialog was open. No effect if the dialog is already closed.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.CreateFromComICoreWebView2(System.IntPtr)">
|
<summary>
|
Creates a CoreWebView2 object that wraps an existing COM ICoreWebView2 object.
|
This allows interacting with the CoreWebView2 using .NET, even if it was originally created using COM.
|
</summary>
|
<param name="value">Pointer to a COM object that implements the ICoreWebView2 COM interface.</param>
|
<returns>Returns a .NET CoreWebView2 object that wraps the COM object.</returns>
|
<exception cref="T:System.ArgumentNullException">Thrown when the provided COM pointer is null.</exception>
|
<exception cref="T:System.Runtime.InteropServices.InvalidComObjectException">Thrown when the value is not an ICoreWebView2 COM object and cannot be wrapped.</exception>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.GetComICoreWebView2">
|
<summary>
|
Returns the existing COM ICoreWebView2 object underlying this .NET CoreWebView2 object.
|
This allows interacting with the WebView2 control using COM APIs,
|
even if the control was originally created using .NET.
|
</summary>
|
<returns>Pointer to a COM object that implements the ICoreWebView2 COM interface.</returns>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsJson(System.String,System.Collections.Generic.List{System.Object})">
|
<summary>
|
Same as <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsJson(System.String)"/>, but also has support for posting DOM
|
objects to page content.
|
</summary>
|
<param name="webMessageAsJson">The web message to be posted to the top level document in
|
this WebView.</param>
|
<param name="additionalObjects"> Additional DOM objects posted to the content.</param>
|
<remarks>
|
The event args is an instance of <c>MessageEvent</c>. The <see
|
cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsWebMessageEnabled"/> setting must be <c>true</c> or the message
|
will not be sent. The event arg's <c>data</c> property of the event arg is the
|
<c>webMessageAsJson</c> string parameter parsed as a JSON string into a JavaScript object.
|
The event arg's <c>source</c> property of the event arg is a reference to the
|
<c>window.chrome.webview</c> object. For information about sending messages from the HTML
|
document in the WebView to the host, navigate to <see
|
cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebMessageReceived"/>. The message is sent asynchronously. If a
|
navigation occurs before the message is posted to the page, the message is not be sent.
|
This additionalObjects is retrieved in web content via the DOM MessageEvent <c>additionalObjects</c>
|
property as an array-like list of DOM objects. Currently these type of objects can be
|
posted:
|
<list type="table">
|
<listheader>
|
<description> .NET / WinRT </description>
|
<description> DOM type </description>
|
</listheader>
|
<item>
|
<description> <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandle"/> </description>
|
<description> [FileSystemHandle](https://developer.mozilla.org/docs/Web/API/FileSystemHandle) </description>
|
</item>
|
<item>
|
<description> <c>null</c> </description>
|
<description> null </description>
|
</item>
|
</list>
|
The objects are posted to web content, following the
|
[structured-clone](https://developer.mozilla.org/docs/Web/API/Web_Workers_API/Structured_clone_algorithm)
|
semantics, meaning only objects that can be cloned can be posted. They will also behave as
|
if they had been created by the web content they are posted to. For example, if a
|
<c>FileSystemFileHandle</c> is posted to a web content it can only be re-transferred via
|
<c>postMessage</c> to other web content [with the same
|
origin](https://fs.spec.whatwg.org/#filesystemhandle).
|
Warning: An app needs to be mindful when using this API to post DOM objects as this API
|
provides the web content with unusual access to sensitive Web Platform features such as
|
filesystem access! Similar to <c>PostWebMessageAsJson</c>, the app should check the <see
|
cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.Source"/> property right before posting the message to ensure the message
|
and objects will only be sent to the target web content that it expects to receive the DOM
|
objects. Additionally, the order of messages that are posted between <c>PostWebMessageAsJson</c>
|
and <c>PostWebMessageAsJsonWithAdditionalObjects</c> may not be preserved.
|
</remarks>
|
<seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsWebMessageEnabled"/>
|
<seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2WebMessageReceivedEventArgs.AdditionalObjects"/>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2.ShowPrintUI">
|
<summary>
|
Opens the browser print preview dialog to print the current web page
|
</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2AcceleratorKeyPressedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.AcceleratorKeyPressed" /> event.</summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2AcceleratorKeyPressedEventArgs.Handled">
|
<summary>
|
Indicates whether the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.AcceleratorKeyPressed" /> event is handled by host.
|
</summary><remarks>
|
If set to <c>true</c> then this prevents the WebView from performing the default action for this accelerator key. Otherwise the WebView will perform the default action for the accelerator key.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2AcceleratorKeyPressedEventArgs.KeyEventKind">
|
<summary>
|
Gets the key event kind that caused the event to run.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2AcceleratorKeyPressedEventArgs.KeyEventLParam">
|
<summary>
|
Gets the LPARAM value that accompanied the window message.
|
</summary><remarks>
|
See the documentation for the <c>WM_KEYDOWN</c> and <c>WM_KEYUP</c> messages.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2AcceleratorKeyPressedEventArgs.PhysicalKeyStatus">
|
<summary>
|
Gets a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PhysicalKeyStatus" /> representing the information passed in the LPARAM of the window message.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2AcceleratorKeyPressedEventArgs.VirtualKey">
|
<summary>
|
Gets the Win32 virtual key code of the key that was pressed or released.
|
</summary><remarks>
|
It is one of the Win32 virtual key constants such as VK_RETURN or an (uppercase) ASCII value such as 'A'. Verify whether Ctrl or Alt are pressed by running GetKeyState(VK_CONTROL) or GetKeyState(VK_MENU).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2AcceleratorKeyPressedEventArgs.IsBrowserAcceleratorKeyEnabled">
|
<summary>
|
This `IsBrowserAcceleratorKeyEnabled` property allows developers to control whether the browser handles accelerator keys such as Ctrl+P or F3, etc.
|
</summary><remarks>
|
The `CoreWebView2Settings.AreBrowserAcceleratorKeysEnabled` API is a convenient setting for developers to disable all the browser accelerator keys together. This setting also sets the default value for the `IsBrowserAcceleratorKeyEnabled` property.
|
|
By default, `CoreWebView2Settings.AreBrowserAcceleratorKeysEnabled` is `TRUE` and `IsBrowserAcceleratorKeyEnabled` is `TRUE`. When developers change `CoreWebView2Settings.AreBrowserAcceleratorKeysEnabled` setting to `FALSE`, this will change default value for `IsBrowserAcceleratorKeyEnabled` to `FALSE`. If developers want specific keys to be handled by the browser after changing the `CoreWebView2Settings.AreBrowserAcceleratorKeysEnabled` setting to `FALSE`, they need to enable these keys by setting `IsBrowserAcceleratorKeyEnabled` to `TRUE`.
|
|
The `CoreWebView2Controller.AcceleratorKeyPressed` event is raised any time an accelerator key is pressed, regardless of whether accelerator keys are enabled or not.
|
|
This API will give the event arg higher priority over the `CoreWebView2Settings.AreBrowserAcceleratorKeysEnabled` setting when we handle the keys.
|
|
With `IsBrowserAcceleratorKeyEnabled` property, if developers mark `IsBrowserAcceleratorKeyEnabled` as `FALSE`, the browser will skip the WebView2 browser feature accelerator key handling process, but the event propagation continues, and web content will receive the key combination.
|
|
This property does not disable accelerator keys related to movement and text editing, such as:
|
- Home, End, Page Up, and Page Down
|
- Ctrl-X, Ctrl-C, Ctrl-V
|
- Ctrl-A for Select All
|
- Ctrl-Z for Undo
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2BasicAuthenticationRequestedEventArgs">
|
<summary>Event args for the BasicAuthenticationRequested event. Will contain the
|
request that led to the HTTP authorization challenge, the challenge
|
and allows the host to provide authentication response or cancel the request.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2BasicAuthenticationRequestedEventArgs.Cancel">
|
<summary>Indicates whether to cancel the authentication request.
|
</summary><remarks><c>false</c> by default. If set to <c>true</c>, Response will be ignored.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2BasicAuthenticationRequestedEventArgs.Challenge">
|
<summary>The authentication challenge string.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2BasicAuthenticationRequestedEventArgs.Response">
|
<summary>Response to the authentication request with credentials. This object will be populated by the app
|
if the host would like to provide authentication credentials.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2BasicAuthenticationRequestedEventArgs.Uri">
|
<summary>The URI that led to the authentication challenge. For proxy authentication
|
requests, this will be the URI of the proxy server.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2BasicAuthenticationRequestedEventArgs.GetDeferral">
|
<summary>
|
Gets a Deferral object.
|
Use this Deferral to defer the decision to show the Basic Authentication dialog.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2BasicAuthenticationResponse">
|
<summary>Represents a Basic HTTP authentication response that contains a user name
|
and a password as according to RFC7617 (https://tools.ietf.org/html/rfc7617).</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2BasicAuthenticationResponse.Password">
|
<summary>Password provided for authentication.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2BasicAuthenticationResponse.UserName">
|
<summary>User name provided for authentication.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2BrowserExtension">
|
<summary>
|
Browser extension installed on current profile.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2BrowserExtension.Id">
|
<summary>
|
This is the browser extension's ID. This is the same browser extension ID returned by the browser extension API [chrome.runtime.id](https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/API/runtime/id). Please see that documentation for more details on how the ID is generated. After an extension is removed, calling <c>Id</c> will return the id of the extension that is removed.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2BrowserExtension.IsEnabled">
|
<summary>
|
If <c>IsEnabled</c> is true then the Extension is enabled and running in WebView instances. If it is false then the Extension is disabled and not running in WebView instances. When a Extension is first installed, <c>IsEnable</c> are default to be <c>true</c>. <c>IsEnabled</c> is persisted per profile. After an extension is removed, calling <c>IsEnabled</c> will return the value at the time it was removed.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2BrowserExtension.Name">
|
<summary>
|
This is the browser extension's name. This value is defined in this browser extension's manifest.json file. If manifest.json define extension's localized name, this value will be the localized version of the name. Please see [Manifest.json name](https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/manifest.json/name) for more details.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2BrowserExtension.RemoveAsync">
|
<summary>
|
Removes this browser extension from its WebView2 Profile. The browser extension is removed immediately including from all currently running HTML documents associated with this WebView2 Profile. The removal is persisted and future uses of this profile will not have this extension installed. After an extension is removed, calling <c>Remove</c> again will cause an exception.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2BrowserExtension.EnableAsync(System.Boolean)">
|
<summary>
|
Sets whether this browser extension is enabled or disabled. This change applies immediately to the extension in all HTML documents in all WebView2s associated with this profile. After an extension is removed, calling <c>Enable</c> will not change the value of <c>IsEnabled</c>.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2BrowserProcessExitedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Environment.BrowserProcessExited" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2BrowserProcessExitedEventArgs.BrowserProcessExitKind">
|
<summary>The kind of browser process exit that has occurred.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2BrowserProcessExitedEventArgs.BrowserProcessId">
|
<summary>The process ID of the browser process that has exited.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2Certificate">
|
<summary>Represents a certificate and provides access to its metadata.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Certificate.DerEncodedSerialNumber">
|
<summary>
|
Base64 encoding of DER encoded serial number of the certificate. Read more about DER at [RFC 7468 DER](https://tools.ietf.org/html/rfc7468#appendix-B).</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Certificate.DisplayName">
|
<summary>Display name for a certificate.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Certificate.Issuer">
|
<summary>Name of the certificate authority that issued the certificate.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Certificate.PemEncodedIssuerCertificateChain">
|
<summary>
|
Returns list of PEM encoded certificate issuer chain. In this list first element is the current certificate followed by intermediate1, intermediate2...intermediateN-1. Root certificate is the last element in the list.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Certificate.Subject">
|
<summary>Subject of the certificate.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Certificate.ToPemEncoding">
|
<summary>
|
PEM encoded data for the certificate. Returns Base64 encoding of DER encoded certificate. Read more about PEM at [RFC 1421 Privacy Enhanced Mail](https://tools.ietf.org/html/rfc1421).</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Certificate.ToX509Certificate2">
|
<summary>
|
Converts this to a X509Certificate2.
|
</summary>
|
<returns>
|
An object created using PEM encoded data from
|
this <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Certificate"/> object.
|
</returns>
|
<seealso cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Certificate.ValidFrom">
|
<summary>
|
The valid date and time for the certificate since the UNIX epoc.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Certificate.ValidTo">
|
<summary>
|
The valid date and time for the certificate since the UNIX epoc.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate">
|
<summary>Represents a client certificate that provides access to the client certificate metadata.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate.DerEncodedSerialNumber">
|
<summary>
|
Base64 encoding of DER encoded serial number of the certificate. Read more about DER at [RFC 7468 DER](https://tools.ietf.org/html/rfc7468#appendix-B).</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate.DisplayName">
|
<summary>Display name for a certificate.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate.Issuer">
|
<summary>Name of the certificate authority that issued the certificate.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate.Kind">
|
<summary>
|
Kind of a certificate. See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateKind" /> for descriptions.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate.PemEncodedIssuerCertificateChain">
|
<summary>
|
Returns list of PEM encoded client certificate issuer chain. In this list first element is the current certificate followed by intermediate1, intermediate2...intermediateN-1. Root certificate is the last element in the list.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate.Subject">
|
<summary>Subject of the certificate.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate.ToPemEncoding">
|
<summary>
|
PEM encoded data for the certificate. Returns Base64 encoding of DER encoded certificate. Read more about PEM at [RFC 1421 Privacy Enhanced Mail](https://tools.ietf.org/html/rfc1421).</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate.ToX509Certificate2">
|
<summary>
|
Converts this to a X509Certificate2.
|
</summary>
|
<returns>
|
An object created using PEM encoded data from
|
this <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate"/> object.
|
</returns>
|
<seealso cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate.ValidFrom">
|
<summary>
|
The valid date and time for the certificate since the UNIX epoc.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate.ValidTo">
|
<summary>
|
The valid date and time for the certificate since the UNIX epoc.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ClientCertificateRequested" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.AllowedCertificateAuthorities">
|
<summary>
|
The list contains Base64 encoding of DER encoded distinguished names of certificate authorities allowed by the server.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.Cancel">
|
<summary>Indicates whether to cancel the certificate selection.
|
</summary><remarks>
|
If canceled, the request is aborted regardless of the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.Handled" /> property. By default the value is false.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.Handled">
|
<summary>
|
Indicates whether the event has been handled by host.
|
</summary><remarks>
|
Set to true to respond to the server with or without a certificate. If this flag is true with a <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.SelectedCertificate" /> it responds to the server with the selected certificate otherwise respond to the server without a certificate. By default the value of <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.Handled" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.Cancel" /> are false and display default client certificate selection dialog prompt to allow the user to choose a certificate. The <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.SelectedCertificate" /> is ignored unless <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.Handled" /> is set to true.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.Host">
|
<summary>Host name of the server that requested client certificate authentication.
|
</summary><remarks>
|
Normalization rules applied to the hostname are:
|
|
<list type="bullet"><item><description>Convert to lowercase characters for ascii characters.</description></item><item><description>Punycode is used for representing non ascii characters.</description></item><item><description>Strip square brackets for IPV6 address.</description></item></list></remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.IsProxy">
|
<summary>Returns true if the server that issued this request is an http proxy. Returns false if the server is the origin server.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.MutuallyTrustedCertificates">
|
<summary>
|
Returns the list of <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificate" /> when client certificate authentication is requested. The list contains mutually trusted CA certificate.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.Port">
|
<summary>Port of the server that requested client certificate authentication.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.SelectedCertificate">
|
<summary>
|
Selected certificate to respond to the server.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2ClientCertificateRequestedEventArgs.GetDeferral">
|
<summary>
|
Gets a Deferral object.
|
Use this to Complete the event at a later time.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController">
|
<summary>
|
This class is an extension of the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Controller" /> class to support visual hosting.</summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.Cursor">
|
<summary>
|
Gets the current cursor that WebView thinks it should be.
|
</summary><remarks>
|
The cursor should be set in WM_SETCURSOR through Mouse.SetCursor or set on the corresponding parent/ancestor HWND of the WebView through ::SetClassLongPtr. The HCURSOR can be freed so CopyCursor/DestroyCursor is recommended to keep your own copy if you are doing more than immediately setting the cursor.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.RootVisualTarget">
|
<summary>
|
Gets or sets the root visual in the hosting app's visual tree.
|
</summary><remarks>
|
This visual is where the WebView will connect its visual tree. The app uses this visual to position the WebView within the app. The app still needs to use the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.Bounds" /> property to size the WebView. The RootVisualTarget property can be an IDCompositionVisual or a Windows::UI::Composition::ContainerVisual. WebView will connect its visual tree to the provided visual before returning from the property setter. The app needs to commit on its device setting the RootVisualTarget property. The RootVisualTarget property supports being set to <c>null</c> to disconnect the WebView from the app's visual tree.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.SystemCursorId">
|
<summary>
|
Gets the current system cursor ID reported by the underlying rendering engine for WebView.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.CursorChanged">
|
<summary>
|
The event is raised when WebView thinks the cursor should be changed.
|
</summary><remarks>
|
For example, when the mouse cursor is currently the default cursor but is then moved over text, it may try to change to the IBeam cursor.
|
It is expected for the developer to send <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.Leave" /> messages (in addition to <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.Move" /> messages) through <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.SendMouseInput(Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind,Microsoft.Web.WebView2.Core.CoreWebView2MouseEventVirtualKeys,System.UInt32,System.Drawing.Point)" />. This is to ensure that the mouse is actually within the WebView that sends out CursorChanged events.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.SendMouseInput(Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind,Microsoft.Web.WebView2.Core.CoreWebView2MouseEventVirtualKeys,System.UInt32,System.Drawing.Point)">
|
<summary /><param name="eventKind">The mouse event kind.</param><param name="virtualKeys">The virtual keys associated with the <c>eventKind</c>.</param><param name="mouseData">The amount of wheel movement.</param><param name="point">The absolute position of the mouse, or the amount of motion since the last mouse event was generated, depending on the <c>eventKind</c>.</param>
|
Sends mouse input to the WebView.
|
<remarks>
|
If <c>eventKind</c> is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.HorizontalWheel" /> or <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.Wheel" />, then <c>mouseData</c> specifies the amount of wheel movement.
|
A positive value indicates that the wheel was rotated forward, away from the user; a negative value indicates that the wheel was rotated backward, toward the user. One wheel click is defined as WHEEL_DELTA, which is 120. If <c>eventKind</c> is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.XButtonDoubleClick" />, <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.XButtonDown" />, or <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.XButtonUp" />, then <c>mouseData</c> specifies which X buttons were pressed or released. This value should be 1 if the first X button is pressed/released and 2 if the second X button is pressed/released. If <c>eventKind</c> is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.Leave" />, then <c>virtualKeys</c>, <c>mouseData</c>, and point should all be zero. If <c>eventKind</c> is any other value, then <c>mouseData</c> should be zero. <c>point</c> is expected to be in the client coordinate space of the WebView. To track mouse events that start in the WebView and can potentially move outside of the WebView and host application, calling SetCapture and ReleaseCapture is recommended. To dismiss hover popups, it is also recommended to send <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind.Leave" /> messages.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.SendPointerInput(Microsoft.Web.WebView2.Core.CoreWebView2PointerEventKind,Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo)">
|
<summary>
|
Sends pen or pointer input to the WebView.
|
</summary><param name="eventKind">The pointer event kind.</param><param name="pointerInfo">The pointer information.</param><remarks>
|
Accepts touch or pen pointer input of kinds defined in <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PointerEventKind" />.
|
Any pointer input from the system must be converted into a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo" /> first.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.DragLeave">
|
<summary>
|
Call this method to inform the CoreWebView2CompositionController that a drag operation has left the WebView.
|
</summary><remarks>
|
Corresponds to the [ICoreDropOperationTarget.LeaveAsync](/uwp/api/windows.applicationmodel.datatransfer.dragdrop.core.icoredropoperationtarget.leaveasync) method when performing a drag operation into the WebView.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.NonClientRegionChanged">
|
<summary>
|
This event is raised when elements on the page with "app-region" CSS property values corresponding to non-client regions change. Use the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionChangedEventArgs.RegionKind" /> to see the kind of non-client region that changed.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.GetNonClientRegionAtPoint(System.Drawing.Point)">
|
<summary>
|
Call this method to perform hit-testing inside of your message loop when the message is WM_NCHITTEST.
|
</summary><param name="point">The point parameter is expected to be in the client coordinate space of the WebView2.</param><returns>The type of <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionKind" /> region which contains the point.</returns>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.QueryNonClientRegion(Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionKind)">
|
<summary>
|
When a given </summary><param name="Kind"> region kind of type <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionKind" /></param><returns>This method returns a vector of rectangles which corresponds to the specified region.</returns><remarks>
|
This method can be used inside the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.NonClientRegionChanged" /> event handler to get the list of rects for the specific region that changed.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ContentLoadingEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContentLoading" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContentLoadingEventArgs.IsErrorPage">
|
<summary><c>true</c> if the loaded content is an error page.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContentLoadingEventArgs.NavigationId">
|
<summary>The ID of the navigation.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem">
|
<summary>Represents a context menu item of a context menu displayed by WebView.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.Children">
|
<summary>
|
Gets the list of children menu items if the kind is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItemKind.Submenu" />.
|
</summary><remarks>
|
If the kind is not <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItemKind.Submenu" />, will return <c>null</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.CommandId">
|
<summary>
|
Gets the Command ID for the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" />.
|
</summary><remarks>
|
Use this to report the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuRequestedEventArgs.SelectedCommandId" /> in <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContextMenuRequested" /> event.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.Icon">
|
<summary>
|
Gets the Icon for the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" /> in PNG, Bitmap or SVG formats in the form of an IStream.
|
</summary><remarks>
|
Stream will be rewound to the start of the image data before being read.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.IsChecked">
|
<summary>
|
Gets or sets the checked property of the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" />.
|
</summary><remarks>
|
Must only be used for custom context menu items that are of kind <c>CoreWebView2ContextMenuItemKind.CheckBox</c> or <c>CoreWebView2ContextMenuItemKind.Radio</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.IsEnabled">
|
<summary>
|
Gets or sets the enabled property of the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" />. Must only be used in the case of a custom context menu item.
|
</summary><remarks>
|
The default value for this is <c>true</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.Kind">
|
<summary>
|
Gets the kind of <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" /> as <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItemKind" />.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.Label">
|
<summary>
|
Gets the localized label for the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" />. Will contain an ampersand for characters to be used as keyboard accelerator.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.Name">
|
<summary>
|
Gets the unlocalized name for the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" />.
|
</summary><remarks>
|
Use this to distinguish between context menu item types. This will be the English label of the menu item in lower camel case. For example, the "Save as" menu item will be "saveAs". Extension menu items will be "extension", custom menu items will be "custom" and spellcheck items will be "spellCheck".
|
Some example context menu item names are:
|
|
<list type="bullet"><item><description>
|
"saveAs"
|
</description></item><item><description>
|
"copyImage"
|
</description></item><item><description>
|
"openLinkInNewWindow"
|
</description></item></list></remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.ShortcutKeyDescription">
|
<summary>
|
Gets the localized keyboard shortcut for this <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" />.
|
</summary><remarks>
|
It will be the empty string if there is no keyboard shortcut. This is text intended to be displayed to the end user to show the keyboard shortcut. For example this property is Ctrl+Shift+I for the "Inspect" <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" />.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.CustomItemSelected">
|
<summary>
|
CustomItemSelected event is raised when the user selects this <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" />.
|
</summary><remarks>
|
Will only be raised for end developer created context menu items.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuRequestedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContextMenuRequested" /> event.
|
</summary><remarks>
|
Will contain the selection information and a collection of all of the default context menu items that the WebView would show. Allows the app to draw its own context menu or add/remove from the default context menu.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuRequestedEventArgs.ContextMenuTarget">
|
<summary>
|
Gets the target information associated with the requested context menu.
|
</summary><seealso cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuRequestedEventArgs.Handled">
|
<summary>
|
Gets or sets whether the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContextMenuRequested" /> event is handled by host after the event handler completes or after the deferral is completed if there is a taken Deferral.
|
</summary><remarks>
|
If Handled is set to <c>true</c> then WebView2 will not display a context menu and will instead use the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuRequestedEventArgs.SelectedCommandId" /> property to indicate which, if any, context menu item to invoke. If after the event handler or deferral completes, Handled is set to <c>false</c> then WebView will display a context menu based on the contents of the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuRequestedEventArgs.MenuItems" /> property. The default value is <c>false</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuRequestedEventArgs.Location">
|
<summary>
|
Gets the coordinates where the context menu request occurred in relation to the upper left corner of the WebView bounds.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuRequestedEventArgs.MenuItems">
|
<summary>
|
Gets the collection of <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" /> objects.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuRequestedEventArgs.SelectedCommandId">
|
<summary>
|
Gets or sets the selected <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" />'s <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.CommandId" />.
|
</summary><remarks>
|
When the app handles the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContextMenuRequested" /> event, it can set this to report the selected command from the context menu. The default value is -1 which means that no selection occurred. The app can also set the command ID for a custom context menu item, which will cause the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.CustomItemSelected" /> event to be fired, however while command IDs for each custom context menu item is unique during a ContextMenuRequested event, WebView may reassign command ID values of deleted custom ContextMenuItems to new objects and the command ID assigned to the same custom item can be different between each app runtime. The command ID should always be obtained via the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.CommandId" /> property.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuRequestedEventArgs.GetDeferral">
|
<summary>
|
Returns a Deferral object.
|
</summary><remarks>
|
Use this operation to complete the event when the custom context menu is closed.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget">
|
<summary>
|
Represents the information regarding the context menu target. Includes the context selected and the appropriate data used for the actions of a context menu.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.FrameUri">
|
<summary>
|
Gets the uri of the frame. Will match the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.PageUri" /> if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.IsRequestedForMainFrame" /> is <c>true</c>.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.HasLinkText">
|
<summary>
|
Returns <c>true</c> if the context menu is requested on text element that contains an anchor tag.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.HasLinkUri">
|
<summary>
|
Returns <c>true</c> if the context menu is requested on HTML containing an anchor tag.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.HasSelection">
|
<summary>
|
Returns <c>true</c> if the context menu is requested on a selection.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.HasSourceUri">
|
<summary>
|
Returns <c>true</c> if the context menu is requested on HTML containing a source uri.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.IsEditable">
|
<summary>
|
Returns <c>true</c> if the context menu is requested on an editable component.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.IsRequestedForMainFrame">
|
<summary>
|
Returns <c>true</c> if the context menu was requested on the main frame and <c>false</c> if invoked on another frame.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.Kind">
|
<summary>
|
Gets the kind of context that the user selected as <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTargetKind" />.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.LinkText">
|
<summary>
|
Gets the text of the link (if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.HasLinkText" /> is <c>true</c>, <c>null</c> otherwise).</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.LinkUri">
|
<summary>
|
Gets the uri of the link (if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.HasLinkUri" /> is <c>true</c>, <c>null</c> otherwise).</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.PageUri">
|
<summary>Gets the uri of the page.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.SelectionText">
|
<summary>
|
Gets the selected text (if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.HasSelection" /> is <c>true</c>, <c>null</c> otherwise).</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.SourceUri">
|
<summary>
|
Gets the active source uri of element (if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuTarget.HasSourceUri" /> is <c>true</c>, <c>null</c> otherwise).</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2Controller">
|
<summary>
|
The owner of the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.CoreWebView2" /> object that provides support for resizing, showing and hiding, focusing, and other functionality related to windowing and composition.
|
</summary><remarks>
|
The CoreWebView2Controller owns the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.CoreWebView2" />, and if all references to the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Controller" /> go away, the WebView is closed.
|
</remarks>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
|
<summary>
|
This class is the owner of the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.CoreWebView2"/> object, and
|
provides support for resizing, showing and hiding, focusing, and other
|
functionality related to windowing and composition.
|
</summary>
|
<remarks>
|
The <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Controller"/> owns the <see
|
cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.CoreWebView2"/>, and if all references to the <see
|
cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Controller"/> go away, the WebView will be closed.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.Bounds">
|
<summary>
|
Gets or sets the WebView bounds.</summary><remarks>
|
Bounds are relative to the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ParentWindow" />. The app has two ways to position a WebView:
|
|
<list type="bullet"><item><description>
|
Create a child HWND that is the WebView parent HWND. Position the window where the WebView should be. Use (0, 0) for the top-left corner (the offset) of the Bounds of the WebView.
|
</description></item><item><description>
|
Use the top-most window of the app as the WebView parent HWND. For example, to position ebView correctly in the app, set the top-left corner of the Bounds of the WebView.
|
</description></item></list>
|
|
The values of Bounds are limited by the coordinate space of the host.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.IsVisible">
|
<summary>
|
Determines whether to show or hide the WebView.
|
</summary><remarks>
|
If `IsVisible` is set to `false`, the WebView is transparent and is not rendered. However, this does not affect the window containing the WebView (the `ParentWindow` parameter that was passed to <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2ControllerAsync(System.IntPtr)" />).
|
WebView as a child window does not get window messages when the top window is minimized or restored. For performance reasons, developers should set the <c>IsVisible</c> property of the WebView to <c>false</c> when the app window is minimized and back to <c>true</c> when the app window is restored. The app window does this by handling <c>SIZE_MINIMIZED</c> and <c>SIZE_RESTORED</c> command upon receiving <c>WM_SIZE</c> message. There are CPU and memory benefits when the page is hidden. For instance Chromium has code that throttles activities on the page like animations and some tasks are run less frequently. Similarly, WebView2 will purge some caches to reduce memory usage.
|
</remarks><seealso cref="M:System.Windows.Forms.Control.Hide" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ParentWindow">
|
<summary>
|
Gets the parent window provided by the app or sets the parent window that this WebView is using to render content.
|
</summary><remarks>
|
It initially returns the `ParentWindow` passed into <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2ControllerAsync(System.IntPtr)" />. Setting the property causes the WebView to re-parent the main WebView window to the newly provided window.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor">
|
<summary>
|
Gets or sets the zoom factor for the WebView.
|
</summary><remarks>
|
Note that changing zoom factor may cause <c>window.innerWidth</c> or <c>window.innerHeight</c> and page layout to change. A zoom factor that is applied by the host by setting this ZoomFactor property becomes the new default zoom for the WebView. This zoom factor applies across navigations and is the zoom factor WebView is returned to when the user presses Ctrl+0. When the zoom factor is changed by the user (resulting in the app receiving <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactorChanged" />), that zoom applies only for the current page. Any user applied zoom is only for the current page and is reset on a navigation. Specifying a ZoomFactor less than or equal to 0 is not allowed. WebView also has an internal supported zoom factor range. When a specified zoom factor is out of that range, it is normalized to be within the range, and a <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactorChanged" /> event is raised for the real applied zoom factor. When this range normalization happens, this reports the zoom factor specified during the previous modification of the ZoomFactor property until the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactorChanged" /> event is received after WebView applies the normalized zoom factor.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.AcceleratorKeyPressed">
|
<summary>
|
AcceleratorKeyPressed is raised when an accelerator key or key combo is pressed or released while the WebView is focused.
|
A key is considered an accelerator if either of the following conditions are true:
|
|
<list type="bullet"><item><description>
|
Ctrl or Alt is currently being held.
|
</description></item><item><description>
|
The pressed key does not map to a character.
|
</description></item></list>
|
|
A few specific keys are never considered accelerators, such as Shift. The Escape key is always considered an accelerator.
|
|
Autorepeated key events caused by holding the key down will also raise this event. Filter out the auto-repeated key events by verifying <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2AcceleratorKeyPressedEventArgs.KeyEventLParam" /> or <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2AcceleratorKeyPressedEventArgs.PhysicalKeyStatus" />.
|
|
In windowed mode, this event is synchronous. Until you set <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2AcceleratorKeyPressedEventArgs.Handled" /> to <c>true</c> or the event handler returns, the browser process is blocked and outgoing cross-process COM calls will fail with RPC_E_CANTCALLOUT_ININPUTSYNCCALL. All <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.CoreWebView2" /> methods work, however.
|
|
In windowless mode, the event is asynchronous. Further input do not reach the browser until the event handler returns or <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2AcceleratorKeyPressedEventArgs.Handled" /> is set to <c>true</c>, but the browser process is not blocked, and outgoing COM calls work normally.
|
|
It is recommended to set <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2AcceleratorKeyPressedEventArgs.Handled" /> to <c>true</c> as early as you are able to know that you want to handle the accelerator key.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.GotFocus">
|
<summary>
|
GotFocus is raised when WebView gets focus.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.LostFocus">
|
<summary>
|
LostFocus is raised when WebView loses focus.
|
</summary><remarks>
|
In the case where <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.MoveFocusRequested" /> event is raised, the focus is still on WebView when <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.MoveFocusRequested" /> event is raised. LostFocus is only raised afterwards when code of the app or default action of <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.MoveFocusRequested" /> event sets focus away from WebView.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.MoveFocusRequested">
|
<summary>
|
MoveFocusRequested is raised when user tries to tab out of the WebView.
|
</summary><remarks>
|
The focus of the WebView has not changed when this event is raised.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactorChanged">
|
<summary>
|
ZoomFactorChanged is raised when the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor" /> property changes.
|
</summary><remarks>
|
The event may be raised because the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor" /> property was modified, or due to the user manually modifying the zoom. When it is modified using the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor" /> property, the internal zoom factor is updated immediately and no ZoomFactorChanged event is raised. WebView associates the last used zoom factor for each site. It is possible for the zoom factor to change when navigating to a different page. When the zoom factor changes due to a navigation change, the ZoomFactorChanged event is raised right after the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ContentLoading" /> event.
|
</remarks><seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Controller.SetBoundsAndZoomFactor(System.Drawing.Rectangle,System.Double)">
|
<summary>
|
Updates <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.Bounds" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor" /> properties at the same time.
|
</summary><param name="Bounds">The bounds to be updated.</param><param name="ZoomFactor">The zoom factor to be updated.</param><remarks>
|
This operation is atomic from the perspective of the host. After returning from this function, the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.Bounds" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor" /> properties are both updated if the function is successful, or neither is updated if the function fails. If <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.Bounds" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor" /> are both updated by the same scale (for example, <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.Bounds" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor" /> are both doubled), then the page does not display a change in <c>window.innerWidth</c> or <c>window.innerHeight</c> and the WebView renders the content at the new size and zoom without intermediate renderings. This function also updates just one of <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor" /> or <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.Bounds" /> by passing in the new value for one and the current value for the other.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Controller.MoveFocus(Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusReason)">
|
<summary>
|
Moves focus into WebView.
|
</summary><param name="reason">The reason for moving focus.</param><remarks>
|
WebView will get focus and focus will be set to correspondent element in the page hosted in the WebView. For <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusReason.Programmatic" /> reason, focus is set to previously focused element or the default element if no previously focused element exists. For <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusReason.Next" /> reason, focus is set to the first element. For <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusReason.Previous" /> reason, focus is set to the last element. WebView changes focus through user interaction including selecting into a WebView or Tab into it. For tabbing, the app runs MoveFocus with <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusReason.Next" /> or <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusReason.Previous" /> to align with Tab and Shift+Tab respectively when it decides the WebView is the next tabbable element.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Controller.NotifyParentWindowPositionChanged">
|
<summary>
|
Tells WebView that the main WebView parent (or any ancestor) HWND moved.
|
</summary><remarks>
|
This is a notification separate from <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.Bounds" />. This is needed for accessibility and certain dialogs in WebView to work correctly.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Controller.Close">
|
<summary>
|
Closes the WebView and cleans up the underlying browser instance.
|
</summary><remarks>
|
Cleaning up the browser instance releases the resources powering the WebView. The browser instance is shut down if no other WebViews are using it.
|
|
After running Close, all methods fail and event handlers stop running. Specifically, the WebView releases the associated references to any associated event handlers when Close is run.
|
|
Close is implicitly run when the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Controller" /> loses the final reference and is destructed. But it is best practice to explicitly run Close to avoid any accidental cycle of references between the WebView and the app code. Specifically, if you capture a reference to the WebView in an event handler you create a reference cycle between the WebView and the event handler. Run Close to break the cycle by releasing all event handlers. But to avoid the situation, it is best to both explicitly run Close on the WebView and to not capture a reference to the WebView to ensure the WebView is cleaned up correctly. Close is synchronous and won't trigger the <c>beforeunload</c> event.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.DefaultBackgroundColor">
|
<summary>
|
Gets or sets the WebView default background color.
|
</summary><remarks>
|
The `DefaultBackgroundColor` is the color that renders underneath all web content. This means WebView renders this color when there is no web content loaded such as before the initial navigation or between navigations. This also means web pages with undefined css background properties or background properties containing transparent pixels will render their contents over this color. Web pages with defined and opaque background properties that span the page will obscure the `DefaultBackgroundColor` and display normally. The default value for this property is white to resemble the native browser experience. Currently this API only supports opaque colors and transparency. It will fail for colors with alpha values that don't equal 0 or 255 ie. translucent colors are not supported. It also does not support transparency on Windows 7. On Windows 7, setting DefaultBackgroundColor to a Color with an Alpha value other than 255 will result in failure. On any OS above Win7, choosing a transparent color will result in showing hosting app content. This means webpages without explicit background properties defined will render web content over hosting app content.
|
This property may also be set via the `WEBVIEW2_DEFAULT_BACKGROUND_COLOR` environment variable. There is a known issue with background color where just setting the color by property can still leave the app with a white flicker before the `DefaultBackgroundColor` property takes effect. Setting the color via environment variable solves this issue. The value must be a hex value that can optionally prepend a 0x. The value must account for the alpha value which is represented by the first 2 digits. So any hex value fewer than 8 digits will assume a prepended 00 to the hex value and result in a transparent color. `DefaultBackgroundColor` will return the result of this environment variable even if it has not been set directly. This environment variable can only set the `DefaultBackgroundColor` once. Subsequent updates to background color must be done by setting the property.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.BoundsMode">
|
<summary>
|
Gets or sets the WebView bounds mode.</summary><remarks>
|
BoundsMode affects how setting the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.Bounds" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.RasterizationScale" /> properties work. Bounds mode can either be in <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2BoundsMode.UseRawPixels" /> mode or <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2BoundsMode.UseRasterizationScale" /> mode.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.RasterizationScale">
|
<summary>
|
Gets or sets the WebView rasterization scale.
|
</summary><remarks>
|
The rasterization scale is the combination of the monitor DPI scale and text scaling set by the user. This value should be updated when the DPI scale of the app's top level window changes (i.e. monitor DPI scale changes or the window changes monitor) or when the text scale factor of the system changes.
|
Rasterization scale applies to the WebView content, as well as popups, context menus, scroll bars, and so on. Normal app scaling scenarios should use the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor" /> property or <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Controller.SetBoundsAndZoomFactor(System.Drawing.Rectangle,System.Double)" /> method.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ShouldDetectMonitorScaleChanges">
|
<summary>
|
Determines whether the WebView will detect monitor scale changes.
|
</summary><remarks>
|
ShouldDetectMonitorScaleChanges property determines whether the WebView attempts to track monitor DPI scale changes. When true, the WebView will track monitor DPI scale changes, update the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.RasterizationScale" /> property, and fire <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.RasterizationScaleChanged" /> event. When <c>false</c>, the WebView will not track monitor DPI scale changes, and the app must update the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.RasterizationScale" /> property itself. <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.RasterizationScaleChanged" /> event will never raise when ShouldDetectMonitorScaleChanges is false. Apps that want to set their own rasterization scale should set this property to false to avoid the WebView2 updating the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.RasterizationScale" /> property to match the monitor DPI scale.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.RasterizationScaleChanged">
|
<summary>
|
RasterizationScaleChanged is raised when the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.RasterizationScale" /> property changes.
|
</summary><remarks>
|
The event is raised when the Webview detects that the monitor DPI scale has changed, <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ShouldDetectMonitorScaleChanges" /> is true, and the Webview has changed the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.RasterizationScale" /> property.
|
</remarks><seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.RasterizationScale" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.AllowExternalDrop">
|
<summary>
|
Gets or sets the WebView allow external drop property.
|
</summary><remarks>
|
The AllowExternalDrop is to configure the capability that dropping files into webview2 is allowed or permitted. The default value is true.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.CoreWebView2">
|
<summary>
|
Gets the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.CoreWebView2"/> associated with this <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Controller"/>.
|
</summary>
|
<seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.CoreWebView2"/>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions">
|
<summary>
|
Used to manage profile options that created by <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2ControllerOptions" />.</summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions.IsInPrivateModeEnabled">
|
<summary>
|
Manage the controller's InPrivate mode.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions.ProfileName">
|
<summary>
|
Manage the name of the controller's profile.
|
</summary><remarks>
|
The <c>ProfileName</c> property is to specify a profile name, which is only allowed to contain the following ASCII characters. It has a maximum length of 64 characters excluding the null-terminator. It is ASCII case insensitive.
|
|
* alphabet characters: a-z and A-Z
|
* digit characters: 0-9
|
* and '#', '@', '$', '(', ')', '+', '-', '_', '~', '.', ' ' (space).
|
|
Note: the text must not end with a period '.' or ' ' (space). And, although upper-case letters are allowed, they're treated just as lower-case counterparts because the profile name will be mapped to the real profile directory path on disk and Windows file system handles path names in a case-insensitive way.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions.DefaultBackgroundColor">
|
<summary>This property allows users to initialize the `DefaultBackgroundColor` early,
|
preventing a white flash that can occur while WebView2 is loading when
|
the background color is set to something other than white. With early
|
initialization, the color remains consistent from the start. After
|
initialization, `CoreWebView2Controller.DefaultBackgroundColor` will return the value set using this API.
|
|
The `CoreWebView2Controller.DefaultBackgroundColor` can be set via the WEBVIEW2_DEFAULT_BACKGROUND_COLOR environment variable,
|
which will remain supported for cases where this solution is being used.
|
It is encouraged to transition away from the environment variable and use this API solution to
|
apply the property. It is important to highlight that when set, the enviroment variable overrides
|
ControllerOptions::DefaultBackgroundColor and becomes the initial value of Controller::DefaultBackgroundColor.
|
|
The `DefaultBackgroundColor` is the color that renders underneath all web
|
content. This means WebView2 renders this color when there is no web
|
content loaded. When no background color is defined in WebView2, it uses
|
the `DefaultBackgroundColor` property to render the background.
|
By default, this color is set to white.
|
|
This API only supports opaque colors and full transparency. It will
|
fail for colors with alpha values that don't equal 0 or 255.
|
When WebView2 is set to be fully transparent, it does not render a background,
|
allowing the content from windows behind it to be visible.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions.AllowHostInputProcessing">
|
<summary>`AllowHostInputProcessing` property is to enable/disable input passing through
|
the app before being delivered to the WebView2. This property is only applicable
|
to controllers created with `CoreWebView2Environment.CreateCoreWebView2ControllerAsync` and not
|
composition controllers created with `CoreWebView2Environment.CreateCoreWebView2CompositionControllerAsync`.
|
By default the value is `FALSE`.
|
Setting this property has no effect when using visual hosting.
|
\snippet AppWindow.cpp AllowHostInputProcessing</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions.ScriptLocale">
|
<summary>
|
Manages the value of the controller's script locale.
|
</summary>
|
<remarks>
|
The <c>ScriptLocale</c> property is to specify the default script
|
locale. It sets the default locale for all Intl JavaScript APIs and
|
other JavaScript APIs that depend on it, namely
|
<c>Intl.DateTimeFormat()</c> which affects string formatting like in
|
the time/date formats.The intended locale value is in the format of
|
BCP 47 Language Tags. More information can be found from [IETF
|
BCP47](https://www.ietf.org/rfc/bcp/bcp47.html ). The default value
|
for ScriptLocale will be depend on the WebView2 language and OS
|
region. If the language portions of the WebView2 language and OS
|
region match, then it will use the OS region. Otherwise, it will use
|
the WebView2 language.
|
<list type="table">
|
<listheader>
|
<description>OS Region</description>
|
<description>WebView2 Language</description>
|
<description>Default WebView2 ScriptLocale</description>
|
</listheader>
|
<item>
|
<description>en-GB</description>
|
<description>en-US</description>
|
<description>en-GB</description>
|
</item>
|
<item>
|
<description>es-MX</description>
|
<description>en-US</description>
|
<description>en-US</description>
|
</item>
|
<item>
|
<description>en-US</description>
|
<description>en-GB</description>
|
<description>en-US</description>
|
</item>
|
</list>
|
You can set the ScriptLocale to the empty string to get the default ScriptLocale value.
|
Use OS specific APIs to determine the OS region to use with this property if you always want to match with the OS
|
region. For example:
|
<code>
|
CultureInfo cultureInfo = Thread.CurrentThread.CurrentCulture;
|
return cultureInfo.Name
|
</code>
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2Cookie">
|
<summary>
|
Provides a set of properties that are used to manage a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Cookie" />.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Domain">
|
<summary>
|
Gets the domain for which the cookie is valid.
|
</summary><remarks>
|
The default value is the host that this cookie has been received from. Note that, for instance, <c>.bing.com</c>, <c>bing.com</c>, and <c>www.bing.com</c> are considered different domains.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.IsHttpOnly">
|
<summary>
|
Determines whether this cookie is http-only.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.IsSecure">
|
<summary>
|
Gets or sets the security level of this cookie.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.IsSession">
|
<summary>
|
Determines whether this is a session cookie. The default value is <c>false</c>.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Name">
|
<summary>
|
Get or sets the cookie name.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Path">
|
<summary>
|
Gets the path for which the cookie is valid.
|
</summary><remarks>
|
The default value is "/", which means this cookie will be sent to all pages on the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Domain" />.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.SameSite">
|
<summary>
|
Determines the SameSite status of the cookie which represents the enforcement mode of the cookie.
|
The default value is <c>CoreWebView2CookieSameSiteKind.Lax</c>.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Value">
|
<summary>
|
Gets or sets the cookie value.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.ToSystemNetCookie">
|
<summary>
|
Converts this to a System.Net.Cookie.
|
</summary>
|
<returns>
|
An object whose <see cref="P:System.Net.Cookie.Name"/>, <see
|
cref="P:System.Net.Cookie.Value"/>, <see cref="P:System.Net.Cookie.Path"/>, <see
|
cref="P:System.Net.Cookie.Domain"/>, <see cref="P:System.Net.Cookie.HttpOnly"/>, <see
|
cref="P:System.Net.Cookie.Secure"/>, and <see cref="P:System.Net.Cookie.Expires"/>, matches
|
those <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Name"/>, <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Value"/>, <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Path"/>,
|
<see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Domain"/>, <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.IsHttpOnly"/>, <see
|
cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.IsSecure"/>, and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Expires"/> of this <see
|
cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Cookie"/> object.
|
</returns>
|
<remarks>
|
The values of the <see cref="T:System.Net.Cookie"/> properties other than those
|
specified above remain their default values.
|
</remarks>
|
<seealso cref="T:System.Net.Cookie"/>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Expires">
|
<summary>
|
The expiration date and time for the cookie since the UNIX epoch.
|
</summary>
|
<remarks>
|
Setting the Expires property to <see cref="F:System.DateTime.MinValue"/>
|
makes this a session cookie, which is its default value.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager">
|
<summary>
|
Creates, adds or updates, gets, or or view the cookies.
|
</summary><remarks>
|
The changes would apply to the context of the user profile. That is, other WebViews under the same user profile could be affected.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager.CreateCookie(System.String,System.String,System.String,System.String)">
|
<summary>
|
Creates a cookie object with a specified name, value, domain, and path.
|
</summary><remarks>
|
One can set other optional properties after cookie creation. This only creates a cookie object and it is not added to the cookie manager until you call <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager.AddOrUpdateCookie(Microsoft.Web.WebView2.Core.CoreWebView2Cookie)" />. name that starts with whitespace(s) is not allowed.
|
</remarks><param name="name">The name for the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Cookie" /> to be created. It cannot start with whitespace(s).</param><param name="cookieValue"></param><param name="Domain"></param><param name="Path"></param>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager.CopyCookie(Microsoft.Web.WebView2.Core.CoreWebView2Cookie)">
|
<summary>
|
Creates a cookie whose params matches those of the specified cookie.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager.GetCookiesAsync(System.String)">
|
<summary>
|
Gets a list of cookies matching the specific URI.
|
</summary><remarks>
|
You can modify the cookie objects by calling <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager.AddOrUpdateCookie(Microsoft.Web.WebView2.Core.CoreWebView2Cookie)" />, and the changes will be applied to the webview.
|
</remarks><param name="uri">If uri is empty string or null, all cookies under the same profile are returned.</param>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager.AddOrUpdateCookie(Microsoft.Web.WebView2.Core.CoreWebView2Cookie)">
|
<summary>
|
Adds or updates a cookie with the given cookie data; may overwrite cookies with matching name, domain, and path if they exist.
|
</summary><param name="cookie">The <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Cookie" /> to be added or updated.</param><remarks>
|
This method will fail if the domain of the given cookie is not specified.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager.DeleteCookie(Microsoft.Web.WebView2.Core.CoreWebView2Cookie)">
|
<summary>
|
Deletes a cookie whose name and domain/path pair match those of the specified cookie.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager.DeleteCookies(System.String,System.String)">
|
<summary>
|
Deletes cookies with matching name and uri.
|
</summary><param name="name">The name for the cookies to be deleted is required.</param><param name="uri">If uri is specified, deletes all cookies with the given name where domain and path match provided URI.</param>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager.DeleteCookiesWithDomainAndPath(System.String,System.String,System.String)">
|
<summary>
|
Deletes cookies with matching name and domain/path pair.
|
</summary><param name="name">The name for the cookies to be deleted is required.</param><param name="Domain">If domain is specified, deletes only cookies with the exact domain.</param><param name="Path">If path is specified, deletes only cookies with the exact path.</param>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager.DeleteAllCookies">
|
<summary>
|
Deletes all cookies under the same profile.
|
</summary><remarks>
|
This could affect other WebViews under the same user profile.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager.CreateCookieWithSystemNetCookie(System.Net.Cookie)">
|
<summary>
|
Creates a CoreWebView2Cookie object whose params matches those of the given System.Net.Cookie.
|
</summary>
|
<param name="systemNetCookie">
|
A System.Net.Cookie whose params to be used to create a CoreWebView2Cookie.
|
</param>
|
<returns>
|
An object whose <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Name"/>, <see
|
cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Value"/>, <see
|
cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Path"/>, <see
|
cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Domain"/>, <see
|
cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.IsHttpOnly"/>, <see
|
cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.IsSecure"/>, and <see
|
cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.Expires"/>, matches those <see
|
cref="P:System.Net.Cookie.Name"/>, <see cref="P:System.Net.Cookie.Value"/>, <see
|
cref="P:System.Net.Cookie.Path"/>, <see cref="P:System.Net.Cookie.Domain"/>, <see
|
cref="P:System.Net.Cookie.HttpOnly"/>, <see cref="P:System.Net.Cookie.Secure"/>, and <see
|
cref="P:System.Net.Cookie.Expires"/> of the given <see cref="T:System.Net.Cookie"/> object.
|
</returns>
|
<remarks>
|
The default value for the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Cookie.SameSite"/>
|
property of the returned <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Cookie"/> object is
|
<see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2CookieSameSiteKind.Lax"/>.
|
</remarks>
|
<seealso cref="T:System.Net.Cookie"/>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2CustomSchemeRegistration">
|
<summary>
|
Represents the registration of a custom scheme with the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment" />.
|
</summary><remarks>
|
This allows the WebView2 app to be able to handle <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event for requests with the specified scheme and be able to navigate the WebView2 to the custom scheme. Once the environment is created, the registrations are valid and immutable throughout the lifetime of the associated WebView2s' browser process and any WebView2 environments sharing the browser process must be created with identical custom scheme registrations, otherwise the environment creation will fail.
|
Any further attempts to register the same scheme will fail during environment creation.
|
The URIs of registered custom schemes will be treated similar to http URIs for their origins.
|
They will have tuple origins for URIs with host and opaque origins for URIs without host as specified in [7.5 Origin - HTML Living Standard](https://html.spec.whatwg.org/multipage/origin.html).
|
|
Example:
|
|
`custom-scheme-with-host://hostname/path/to/resource` has origin of `custom-scheme-with-host://hostname`.
|
`custom-scheme-without-host:path/to/resource` has origin of `custom-scheme-without-host:path/to/resource`.
|
|
For <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event, the cases of request URIs and filter URIs with custom schemes will be normalized according to generic URI syntax rules. Any non-ASCII characters will be preserved.
|
The registered custom schemes also participate in [CORS](https://developer.mozilla.org/docs/Web/HTTP/CORS) and adheres to [CSP](https://developer.mozilla.org/docs/Web/HTTP/CSP).
|
The app needs to set the appropriate access headers in its <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event handler to allow CORS requests.
|
</remarks>
|
<summary>
|
Represents the registration of a custom scheme with the <see
|
cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment"/>.
|
</summary>
|
<remarks>
|
This allows the WebView2 app to be able to handle <see
|
cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested"/> event for requests with the
|
specified scheme and be able to navigate the WebView2 to the custom
|
scheme. Once the environment is created, the registrations are valid and
|
immutable throughout the lifetime of the associated WebView2s' browser
|
process and any WebView2 environments sharing the browser process must be
|
created with identical custom scheme registrations, otherwise the
|
environment creation will fail. Any further attempts to register the same
|
scheme will fail during environment creation. The URIs of registered
|
custom schemes will be treated similar to http URIs for their origins.
|
They will have tuple origins for URIs with host and opaque origins for
|
URIs without host as specified in [7.5 Origin - HTML Living Standard](https://html.spec.whatwg.org/multipage/origin.html) For <see
|
cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested"/> event, the cases of request
|
URIs and filter URIs with custom schemes will be normalized according to
|
generic URI syntax rules. Any non-ASCII characters will be preserved. The
|
registered custom schemes also participate in [CORS](https://developer.mozilla.org/docs/Web/HTTP/CORS) and adheres to
|
[CSP](https://developer.mozilla.org/docs/Web/HTTP/CSP). The app needs to
|
set the appropriate access headers in its <see
|
cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested"/> event handler to allow CORS
|
requests.
|
</remarks>
|
<example>
|
<c>custom-scheme-with-host://hostname/path/to/resource</c> has origin of
|
<c>custom-scheme-with-host://hostname</c>.
|
<c>custom-scheme-without-host:path/to/resource</c> has origin of
|
<c>custom-scheme-without-host:path/to/resource</c>.
|
</example>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2CustomSchemeRegistration.SchemeName">
|
<summary>
|
The name of the custom scheme to register.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2CustomSchemeRegistration.TreatAsSecure">
|
<summary>
|
Whether the sites with this scheme will be treated as a [Secure
|
Context](https://developer.mozilla.org/docs/Web/Security/Secure_Contexts)
|
like an HTTPS site.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2CustomSchemeRegistration.HasAuthorityComponent">
|
<summary>
|
Set this property to <c>true</c> if the URIs with this custom scheme
|
will have an authority component (a host for custom schemes).
|
Specifically, if you have a URI of the following form you should set the
|
<c>HasAuthorityComponent</c> value as listed.
|
|
<list type="table">
|
<listheader>
|
<description>URI</description>
|
<description>Recommended HasAuthorityComponent value</description>
|
</listheader>
|
<item>
|
<description><c>custom-scheme-with-authority://host/path</c></description>
|
<description><c>true</c></description>
|
</item>
|
<item>
|
<description><c>custom-scheme-without-authority:path</c></description>
|
<description><c>false</c></description>
|
</item>
|
</list>
|
</summary>
|
<remarks>
|
When this property is set to <c>true</c>, the URIs with this scheme will
|
be interpreted as having a [scheme and
|
host](https://html.spec.whatwg.org/multipage/origin.html#concept-origin-tuple)
|
origin similar to an http URI. Note that the port and user information
|
are never included in the computation of origins for custom schemes. If
|
this property is set to <c>false</c>, URIs with this scheme will have an
|
[opaque
|
origin](https://html.spec.whatwg.org/multipage/origin.html#concept-origin-opaque)
|
similar to a data URI. This property is <c>false</c> by default. Note:
|
For custom schemes registered as having authority component, navigations
|
to URIs without authority of such custom schemes will fail. However, if
|
the content inside WebView2 references a subresource with a URI that
|
does not have an authority component, but of a custom scheme that is
|
registered as having authority component, the URI will be interpreted as
|
a relative path as specified in
|
[RFC3986](https://www.rfc-editor.org/rfc/rfc3986). For example,
|
<c>custom-scheme-with-authority:path</c> will be interpreted as
|
<c>custom-scheme-with-authority://host/path</c>. However, this behavior
|
cannot be guaranteed to remain in future releases so it is recommended
|
not to rely on this behavior.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2CustomSchemeRegistration.AllowedOrigins">
|
<summary>
|
List of origins that are allowed to issue requests with the custom
|
scheme, such as XHRs and subresource requests that have an Origin
|
header.
|
</summary>
|
<remarks>
|
The origin of any request (requests that have the [Origin
|
header](https://developer.mozilla.org/docs/Web/HTTP/Headers/Origin)) to
|
the custom scheme URI needs to be in this list. No-origin requests are
|
requests that do not have an Origin header, such as link navigations,
|
embedded images and are always allowed. Note that cross-origin
|
restrictions still apply. From any opaque origin (Origin header is
|
null), no cross-origin requests are allowed. If the list is empty, no
|
cross-origin request to this scheme is allowed. Origins are specified as
|
a string in the format of <c>scheme://host:port</c>. The origins are
|
string pattern matched with <c>*</c> (matches 0 or more characters) and
|
<c>?</c> (matches 0 or 1 character) wildcards just like the URI matching
|
in the <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddWebResourceRequestedFilter(System.String,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceContext,Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestSourceKinds)"/>
|
API. For example, <c>http://*.example.com:80</c>.
|
|
Here's a set of examples of what is allowed or not:
|
|
<list type="table">
|
<listheader>
|
<description>Request URI</description>
|
<description>Originating URL</description>
|
<description>AllowedOrigins</description>
|
<description>Allowed</description>
|
</listheader>
|
<item>
|
<description><c>custom-scheme:request</c></description>
|
<description><c>https://www.example.com</c></description>
|
<description>{"https://www.example.com"}</description>
|
<description>Yes</description>
|
</item>
|
<item>
|
<description><c>custom-scheme:request</c></description>
|
<description><c>https://www.example.com</c></description>
|
<description>{"https://*.example.com"}</description>
|
<description>Yes</description>
|
</item>
|
<item>
|
<description><c>custom-scheme:request</c></description>
|
<description><c>https://www.example.com</c></description>
|
<description>{"https://www.example2.com"}</description>
|
<description>No</description>
|
</item>
|
<item>
|
<description><c>custom-scheme-with-authority://host/path</c></description>
|
<description><c>custom-scheme-with-authority://host2</c></description>
|
<description>{""}</description>
|
<description>No</description>
|
</item>
|
<item>
|
<description><c>custom-scheme-with-authority://host/path</c></description>
|
<description><c>custom-scheme-with-authority2://host</c></description>
|
<description>{"custom-scheme-with-authority2://*"}</description>
|
<description>Yes</description>
|
</item>
|
<item>
|
<description><c>custom-scheme-without-authority:path</c></description>
|
<description>custom-scheme-without-authority:path2</description>
|
<description>{"custom-scheme-without-authority:*"}</description>
|
<description>No</description>
|
</item>
|
<item>
|
<description><c>custom-scheme-without-authority:path</c></description>
|
<description>custom-scheme-without-authority:path2</description>
|
<description>{"*"}</description>
|
<description>Yes</description>
|
</item>
|
</list>
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2CustomSchemeRegistration.#ctor(System.String)">
|
<summary>
|
Initializes a new instance of the CoreWebView2CustomSchemeRegistration
|
class.
|
</summary>
|
<param name="schemeName">
|
The name of the custom scheme to register.
|
</param>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2DOMContentLoadedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.DOMContentLoaded" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DOMContentLoadedEventArgs.NavigationId">
|
<summary>The ID of the navigation which corresponds to other navigation ID properties on other navigation events.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2Deferral">
|
<summary>
|
This is used to complete deferrals on event args that support getting deferrals using the <c>GetDeferral</c> method. This class implements <see cref="T:System.IDisposable" />.</summary>
|
<summary>
|
This is used to complete deferrals on event args that support getting deferrals using the <c>GetDeferral</c> method. This class implements <see cref="T:System.IDisposable"/>.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Deferral.Complete">
|
<summary>
|
Completes the associated deferred event.
|
</summary><remarks>
|
Complete should only be run once for each deferral taken.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Deferral.Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Deferral.Dispose(System.Boolean)">
|
<summary>
|
Protected implementation of Dispose pattern.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2DevToolsProtocolEventReceivedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2DevToolsProtocolEventReceiver.DevToolsProtocolEventReceived" /> event.</summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DevToolsProtocolEventReceivedEventArgs.ParameterObjectAsJson">
|
<summary>
|
Gets the parameter object of the corresponding DevToolsProtocol event represented as a JSON string.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DevToolsProtocolEventReceivedEventArgs.SessionId">
|
<summary>
|
Gets the sessionId of the target where the event originates from. Empty string is returned as sessionId if the event comes from the default session for the top page.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2DevToolsProtocolEventReceiver">
|
<summary>
|
A Receiver is created for a particular DevTools Protocol event and allows you to subscribe and unsubscribe from that event.
|
</summary><remarks>
|
Obtained from the WebView object using <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.GetDevToolsProtocolEventReceiver(System.String)" />.
|
</remarks><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.GetDevToolsProtocolEventReceiver(System.String)" />
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2DevToolsProtocolEventReceiver.DevToolsProtocolEventReceived">
|
<summary>
|
DevToolsProtocolEventReceived is raised when the corresponding DevToolsProtocol event is raised.
|
</summary><seealso cref="T:Microsoft.Web.WebView2.Core.CoreWebView2DevToolsProtocolEventReceivedEventArgs" />
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation">
|
<summary>
|
Represents a download operation. Gives access to a download's metadata and supports a user canceling, pausing, or resuming a download.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.BytesReceived">
|
<summary>The number of bytes that have been written to the download file.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.CanResume">
|
<summary>
|
Returns true if an interrupted download can be resumed.
|
Downloads with the following interrupt reasons may automatically resume without you calling any methods: <c>CoreWebView2DownloadInterruptReason.ServerNoRange</c>, <c>CoreWebView2DownloadInterruptReason.FileHashMismatch</c>, <c>CoreWebView2DownloadInterruptReason.FileTooShort</c>. In these cases progress may be restarted with <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.BytesReceived" /> set to 0.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.ContentDisposition">
|
<summary>
|
The Content-Disposition header value from the download's HTTP response. If none, the value is an empty string.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.InterruptReason">
|
<summary>
|
The reason why connection with file host was broken.
|
</summary><remarks>
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2DownloadInterruptReason" /> for descriptions of reasons.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.MimeType">
|
<summary>
|
MIME type of the downloaded content.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.ResultFilePath">
|
<summary>
|
The absolute path to the download file, including file name.
|
</summary><remarks>
|
Host can change this from <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadStartingEventArgs.ResultFilePath" />.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.State">
|
<summary>
|
The state of the download. A download can be in progress, interrupted, or completed.
|
</summary><remarks>
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2DownloadState" /> for descriptions of states.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.Uri">
|
<summary>
|
The URI of the download.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.BytesReceivedChanged">
|
<summary>
|
Event raised when the bytes received count is updated.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.EstimatedEndTimeChanged">
|
<summary>
|
Event raised when the estimated end time changes.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.StateChanged">
|
<summary>
|
Event raised when the state of the download changes.
|
Use <c>CoreWebView2DownloadOperation.State</c> to get the current state, and <c>CoreWebView2DownloadOperation.InterruptReason</c> to get the reason if the download is interrupted.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.Cancel">
|
<summary>
|
Cancels the download.
|
</summary><remarks>
|
If canceled, the default download dialog shows that the download was canceled. Host should use <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadStartingEventArgs.Cancel" /> if download should be canceled without displaying the default download dialog.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.Pause">
|
<summary>
|
Pauses the download.
|
If paused, the default download dialog shows that the download is paused. No effect if download is already paused. Pausing a download changes the state from in progress to interrupted, with interrupt reason set to <c>CoreWebView2DownloadInterruptReason.UserCanceled</c>.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.Resume">
|
<summary>
|
Resumes a paused download. May also resume a download that was interrupted for another reason if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.CanResume" /> returns true.
|
</summary><remarks>
|
Resuming a download changes the state from interrupted to in progress.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.EstimatedEndTime">
|
<summary>
|
The estimated end time of the download.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation.TotalBytesToReceive">
|
<summary>
|
The total bytes to receive count.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2DownloadStartingEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.DownloadStarting" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadStartingEventArgs.Cancel">
|
<summary>
|
Indicates whether to cancel the download.
|
If canceled, the download save dialog is not displayed regardless of the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadStartingEventArgs.Handled" /> value and the state is changed to <c>CoreWebView2DownloadState.Interrupted</c> with interrupt reason <c>CoreWebView2DownloadInterruptReason.UserCanceled</c>.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadStartingEventArgs.DownloadOperation">
|
<summary>
|
Returns the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2DownloadOperation" /> for the download that has started.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadStartingEventArgs.Handled">
|
<summary>
|
Indicates whether to hide the default download dialog.
|
</summary><remarks>
|
If set to true, the default download dialog is hidden for this download. The download progresses normally if it is not canceled, there will just be no default UI shown. By default the value is false and the default download dialog is shown.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2DownloadStartingEventArgs.ResultFilePath">
|
<summary>
|
The path to the file.
|
</summary><remarks>
|
If setting the path, the host should ensure that it is an absolute path, including the file name, and that the path does not point to an existing file. If the path points to an existing file, the file will be overwritten. If the directory does not exist, it is created.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2DownloadStartingEventArgs.GetDeferral">
|
<summary>
|
Gets a Deferral object.
|
Use this to Complete the event at a later time.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment">
|
<summary>
|
This represents the WebView2 Environment.
|
WebViews created from an environment run on the Browser process specified with environment parameters and objects created from an environment should be used in the same environment. Using it in different environments are not guaranteed to be compatible and may fail.</summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary>
|
This represents the WebView2 Environment.
|
</summary>
|
<remarks>
|
WebViews created from an environment run on the Browser process specified with environment parameters and objects created from an environment should be used in the same environment. Using it in different environments are not guaranteed to be compatible and may fail.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Environment.BrowserVersionString">
|
<summary>
|
Gets the browser version info of the current <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment" />, including channel name if it is not the stable channel.
|
</summary><remarks>
|
It matches the format of the <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.GetAvailableBrowserVersionString(System.String)" /> method. Channel names are <c>beta</c>, <c>dev</c>, and <c>canary</c>.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Environment.NewBrowserVersionAvailable">
|
<summary>
|
NewBrowserVersionAvailable is raised when a newer version of the WebView2 Runtime is installed and available using WebView2.
|
</summary><remarks>
|
To use the newer version of the browser you must create a new environment and WebView. The event is only raised for new version from the same WebView2 Runtime from which the code is running. When not running with installed WebView2 Runtime, no event is raised.
|
|
Because a user data folder is only able to be used by one browser process at a time, if you want to use the same user data folder in the WebViews using the new version of the browser, you must close the environment and instance of WebView that are using the older version of the browser first. Or simply prompt the user to restart the app.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2ControllerAsync(System.IntPtr)">
|
<summary>
|
Asynchronously creates a new WebView.
|
</summary><param name="ParentWindow">The HWND in which the WebView should be displayed and from which receive input.</param><remarks>
|
The WebView adds a child window to the provided window during WebView creation. Z-order and other things impacted by sibling window order are affected accordingly.
|
|
<para>
|
HWND_MESSAGE is a valid parameter for <c>ParentWindow</c> for an invisible WebView for Windows 8 and above. In this case the window will never become visible. You are not able to reparent the window after you have created the WebView. This is not supported in Windows 7 or below. Passing this parameter in Windows 7 or below will return ERROR_INVALID_WINDOW_HANDLE in the controller callback.
|
</para><para>
|
It can also accept a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions" /> which is created by <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2ControllerOptions" /> as the second parameter for multiple profiles support. As WebView2 is built on top of Edge browser, it follows Edge's behavior pattern. To create an InPrivate WebView, we gets an off-the-record profile (an InPrivate profile) from a regular profile, then create the WebView with the off-the-record profile. Multiple profiles under single user data directory can share some system resources including memory, CPU footprint, disk space (such as compiled shaders and safebrowsing data) etc.
|
</para><para>
|
It is recommended that the application set Application User Model ID for the process or the application window. If none is set, during WebView creation a generated Application User Model ID is set to root window of <c>ParentWindow</c>.
|
</para><para>
|
It is recommended that the app handles restart manager messages, to gracefully restart it in the case when the app is using the WebView2 Runtime from a certain installation and that installation is being uninstalled. For example, if a user installs a version of the WebView2 Runtime and opts to use another version of the WebView2 Runtime for testing the app, and then uninstalls the 1st version of the WebView2 Runtime without closing the app, the app restarts to allow un-installation to succeed.
|
</para><para>
|
When the app retries CreateCoreWebView2ControllerAsync upon failure, it is recommended that the app restarts from creating a new WebView2 Environment. If a WebView2 Runtime update happens, the version associated with a WebView2 Environment may have been removed and causing the object to no longer work. Creating a new WebView2 Environment works since it uses the latest version.
|
</para><para>
|
WebView creation fails if a running instance using the same user data folder exists, and the Environment objects have different <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions" />. For example, if a WebView was created with one <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.Language" />, an attempt to create a WebView with a different <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.Language" /> using the same user data folder fails.
|
</para><para>
|
WebView creation can fail with `E_UNEXPECTED` if runtime does not have permissions to the user data folder.
|
</para></remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateWebResourceResponse(System.IO.Stream,System.Int32,System.String,System.String)">
|
<summary>
|
Creates a new <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponse" /> object.
|
</summary><param name="Content">HTTP response content as stream.</param><param name="StatusCode">The HTTP response status code.</param><param name="ReasonPhrase">The HTTP response reason phrase.</param><param name="Headers">The raw response header string delimited by newline.</param><remarks>
|
It is also possible to create this object with empty headers string and then use the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders" /> to construct the headers line by line.
|
</remarks><seealso cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponse" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2ControllerAsync(System.IntPtr,Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions)">
|
<summary>Create a new WebView with options.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2CompositionControllerAsync(System.IntPtr,Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions)">
|
<summary>Create a new WebView in visual hosting mode with options.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Environment.FailureReportFolderPath">
|
<summary>
|
Gets the failure report folder that all CoreWebView2s created from this environment are using.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateSharedBuffer(System.UInt64)">
|
<summary>
|
Create a shared memory based buffer with the specified size in bytes.
|
</summary><remarks>
|
The buffer can be shared with web contents in WebView by calling <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostSharedBufferToScript(Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer,Microsoft.Web.WebView2.Core.CoreWebView2SharedBufferAccess,System.String)" /> or <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Frame.PostSharedBufferToScript(Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer,Microsoft.Web.WebView2.Core.CoreWebView2SharedBufferAccess,System.String)" />.
|
Once shared, the same content of the buffer will be accessible from both the app process and script in WebView.
|
Modification to the content will be visible to all parties that have access to the buffer.
|
The shared buffer is presented to the script as ArrayBuffer. All JavaScript APIs that work for ArrayBuffer including Atomics APIs can be used on it.
|
There is currently a limitation that only size less than 2GB is supported.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.GetProcessExtendedInfosAsync">
|
<summary>
|
Returns a snapshot collection of <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessInfo" /> corresponding to all currently running processes associated with this <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment" /> excludes crashpad process. This provides the same list of <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessInfo" /> as what's provided in <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.GetProcessInfos" />, but additionally provides a list of associated <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo" /> which are actively running (showing or hiding UI elements) in the renderer process. See <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessExtendedInfo.AssociatedFrameInfos" /> for more information.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateWebFileSystemFileHandle(System.String,Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandlePermission)">
|
<summary>Create a `ICoreWebView2FileSystemHandle` object from a path that represents a Web
|
[FileSystemFileHandle](https://developer.mozilla.org/docs/Web/API/FileSystemFileHandle).
|
|
The `path` is the path pointed by the file and must be a syntactically correct fully qualified
|
path, but it is not checked here whether it currently points to a file. If an invalid path is
|
passed, an E_INVALIDARG will be returned and the object will fail to create. Any other state
|
validation will be done when this handle is accessed from web content
|
and will cause the DOM exceptions described in
|
[FileSystemFileHandle methods](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle#instance_methods)
|
if access operations fail.
|
|
`Permission` property is used to specify whether the Handle should be created with a Read-only or
|
Read-and-write web permission. For the `permission` value specified here, the DOM
|
[PermissionStatus](https://developer.mozilla.org/docs/Web/API/PermissionStatus) property
|
will be [granted](https://developer.mozilla.org/docs/Web/API/PermissionStatus/state)
|
and the unspecified permission will be
|
[prompt](https://developer.mozilla.org/docs/Web/API/PermissionStatus/state). Therefore,
|
the web content then does not need to call
|
[requestPermission](https://developer.mozilla.org/docs/Web/API/FileSystemHandle/requestPermission)
|
for the permission that was specified before attempting the permitted operation,
|
but if it does, the promise will immediately be resolved
|
with 'granted' PermissionStatus without firing the WebView2
|
[PermissionRequested](/microsoft-edge/webview2/reference/win32/icorewebview2permissionrequestedeventargs)
|
event or prompting the user for permission. Otherwise, `requestPermission` will behave as the
|
status of permission is currently `prompt`, which means the `PermissionRequested` event will fire
|
or the user will be prompted.
|
Additionally, the app must have the same OS permissions that have propagated to the
|
[WebView2 browser process](/microsoft-edge/webview2/concepts/process-model)
|
for the path it wishes to give the web content to read/write the file.
|
Specifically, the WebView2 browser process will run in same user, package identity, and app
|
container of the app, but other means such as security context impersonations do not get
|
propagated, so such permissions that the app has, will not be effective in WebView2.
|
Note: An exception to this is, if there is a parent directory handle that
|
has broader permissions in the same page context than specified in here, the handle will automatically
|
inherit the most permissive permission of the parent handle when posted to that page context.
|
i.e. If there is already a `FileSystemDirectoryHandle` to `C:\example` that has write permission on
|
a page, even though a WebFileSystemHandle to file `C:\example\file.txt` is created with
|
`COREWEBVIEW2_FILE_SYSTEM_HANDLE_PERMISSION_READ_ONLY` permission, when posted to that page, write permission
|
will be automatically granted to the created handle.
|
|
An app needs to be mindful that this object, when posted to the web content, provides it with unusual
|
access to OS file system via the Web FileSystem API! The app should therefore only post objects
|
for paths that it wants to allow access to the web content and it is not recommended that the web content
|
"asks" for this path. The app should also check the source property of the target to ensure
|
that it is sending to the web content of intended origin.
|
|
Once the object is passed to web content, if the content is attempting a read,
|
the file must be existing and available to read similar to a file chosen by
|
[open file picker](https://developer.mozilla.org/docs/Web/API/Window/showOpenFilePicker),
|
otherwise the read operation will
|
[throw a DOM exception](https://developer.mozilla.org/docs/Web/API/FileSystemFileHandle/getFile#exceptions).
|
For write operations, the file does not need to exist as `FileSystemFileHandle` will behave
|
as a file path chosen by
|
[save file picker](https://developer.mozilla.org/docs/Web/API/Window/showSaveFilePicker)
|
and will create or overwrite the file, but the parent directory structure pointed
|
by the file must exist and an existing file must be available to write and delete
|
or the write operation will
|
[throw a DOM exception](https://developer.mozilla.org/docs/Web/API/FileSystemFileHandle/createWritable#exceptions).</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateWebFileSystemDirectoryHandle(System.String,Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandlePermission)">
|
<summary>Create a `ICoreWebView2FileSystemHandle` object from a path that represents a Web
|
[FileSystemDirectoryHandle](https://developer.mozilla.org/docs/Web/API/FileSystemDirectoryHandle).
|
|
The `path` is the path pointed by the directory and must be a syntactically correct fully qualified
|
path, but it is not checked here whether it currently points to a directory. Any other state
|
validation will be done when this handle is accessed from web content
|
and will cause DOM exceptions if access operations fail. If an invalid path is
|
passed, an E_INVALIDARG will be returned and the object will fail to create.
|
|
`Permission` property is used to specify whether the Handle should be created with a Read-only or
|
Read-and-write web permission. For the `permission` value specified here, the Web
|
[PermissionStatus](https://developer.mozilla.org/docs/Web/API/PermissionStatus)
|
will be [granted](https://developer.mozilla.org/docs/Web/API/PermissionStatus/state)
|
and the unspecified permission will be
|
[prompt](https://developer.mozilla.org/docs/Web/API/PermissionStatus/state). Therefore,
|
the web content then does not need to call
|
[requestPermission](https://developer.mozilla.org/docs/Web/API/FileSystemHandle/requestPermission)
|
for the permission that was specified before attempting the permitted operation,
|
but if it does, the promise will immediately be resolved
|
with 'granted' PermissionStatus without firing the WebView2
|
[PermissionRequested](/microsoft-edge/webview2/reference/win32/icorewebview2permissionrequestedeventargs)
|
event or prompting the user for permission. Otherwise, `requestPermission` will behave as the
|
status of permission is currently `Prompt`, which means the `PermissionRequested` event will fire
|
or the user will be prompted.
|
Additionally, the app must have the same OS permissions that have propagated to the
|
[WebView2 browser process](/microsoft-edge/webview2/concepts/process-model)
|
for the path it wishes to give the web content to make any operations on the directory.
|
Specifically, the WebView2 browser process will run in same user, package identity, and app
|
container of the app, but other means such as security context impersonations do not get
|
propagated, so such permissions that the app has, will not be effective in WebView2.
|
Note: An exception to this is, if there is a parent directory handle that
|
has broader permissions in the same page context than specified in here, the handle will automatically
|
inherit the most permissive permission of the parent handle when posted to that page context.
|
i.e. If there is already a `FileSystemDirectoryHandle` to `C:\example` that has write permission on
|
a page, even though a WebFileSystemHandle to directory `C:\example\directory` is created with
|
`COREWEBVIEW2_FILE_SYSTEM_HANDLE_PERMISSION_READ_ONLY` permission, when posted to that page, write permission
|
will be automatically granted to the created handle.
|
|
An app needs to be mindful that this object, when posted to the web content, provides it with unusual
|
access to OS file system via the Web FileSystem API! The app should therefore only post objects
|
for paths that it wants to allow access to the web content and it is not recommended that the web content
|
"asks" for this path. The app should also check the source property of the target to ensure
|
that it is sending to the web content of intended origin.
|
|
Once the object is passed to web content, the path must point to a directory as if it was chosen via
|
[directory picker](https://developer.mozilla.org/docs/Web/API/Window/showDirectoryPicker)
|
otherwise any IO operation done on the `FileSystemDirectoryHandle` will throw a DOM exception.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateWebResourceRequest(System.String,System.String,System.IO.Stream,System.String)">
|
<summary>
|
Creates a new <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequest" /> object.
|
</summary><param name="uri">The request URI.</param><param name="Method">The HTTP request method.</param><param name="postData"></param><param name="Headers">The raw request header string delimited by CRLF (optional in last header).</param><remarks><c>uri</c> parameter must be absolute URI. It's also possible to create this object with <c>null</c> headers string and then use the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders" /> to construct the headers line by line.
|
</remarks><seealso cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequest" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2CompositionControllerAsync(System.IntPtr)">
|
<summary>
|
Asynchronously creates a new WebView for use with visual hosting.</summary><param name="ParentWindow">The HWND in which the app will connect the visual tree of the WebView.</param><remarks><c>ParentWindow</c> will be the HWND that the app will receive pointer/mouse input meant for the WebView (and will need to use <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.SendMouseInput(Microsoft.Web.WebView2.Core.CoreWebView2MouseEventKind,Microsoft.Web.WebView2.Core.CoreWebView2MouseEventVirtualKeys,System.UInt32,System.Drawing.Point)" /> or <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.SendPointerInput(Microsoft.Web.WebView2.Core.CoreWebView2PointerEventKind,Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo)" /> to forward). If the app moves the WebView visual tree to underneath a different window, then it needs to set <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ParentWindow" /> to update the new parent HWND of the visual tree.
|
|
Set <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.RootVisualTarget" /> property on the created <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController" /> to provide a visual to host the browser's visual tree.
|
|
It is recommended that the application set Application User Model ID for the process or the application window. If none is set, during WebView creation a generated Application User Model ID is set to root window of <c>ParentWindow</c>.
|
|
It can also accept a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions" /> which is created by <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2ControllerOptions" /> as the second parameter for multiple profiles support.
|
|
CreateCoreWebView2CompositionController is supported in the following versions of Windows:
|
|
<list type="bullet"><item><description>Windows 11</description></item><item><description>Windows 10</description></item><item><description>Windows Server 2019</description></item><item><description>Windows Server 2016</description></item></list></remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2PointerInfo">
|
<summary>
|
Creates an empty <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo" />.
|
</summary><remarks>
|
The returned <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo" /> needs to be populated with all of the relevant info before calling <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.SendPointerInput(Microsoft.Web.WebView2.Core.CoreWebView2PointerEventKind,Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo)" />.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Environment.BrowserProcessExited">
|
<summary>
|
BrowserProcessExited is raised when the collection of WebView2 Runtime processes for the browser process of this <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment" /> terminate due to browser process failure or normal shutdown (for example, when all associated WebViews are closed), after all resources have been released (including the user data folder).</summary><remarks>
|
Multiple app processes can share a browser process by creating their webviews from a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment" /> with the same user data folder. When the entire collection of WebView2Runtime processes for the browser process exit, all associated <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment" /> objects receive the BrowserProcessExited event. Multiple processes sharing the same browser process need to coordinate their use of the shared user data folder to avoid race conditions and unnecessary waits. For example, one process should not clear the user data folder at the same time that another process recovers from a crash by recreating its WebView controls; one process should not block waiting for the event if other app processes are using the same browser process (the browser process will not exit until those other processes have closed their webviews too).
|
Note this is an event from <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment" />, not <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2" />. The difference between BrowserProcessExited and <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ProcessFailed" /> is that BrowserProcessExited is raised for any <strong>browser process</strong> exit (expected or unexpected, after all associated processes have exited too), while <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ProcessFailed" /> is raised for <strong>unexpected</strong> process exits of any kind (browser, render, GPU, and all other types), or for main frame <strong>render process</strong> unresponsiveness. To learn more about the WebView2 Process Model, go to [Process model](/microsoft-edge/webview2/concepts/process-model).
|
In the case the browser process crashes, both BrowserProcessExited and <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ProcessFailed" /> events are raised, but the order is not guaranteed. These events are intended for different scenarios. It is up to the app to coordinate the handlers so they do not try to perform reliability recovery while also trying to move to a new WebView2 Runtime version or remove the user data folder.
|
</remarks><example>
|
:::code language="csharp" source="../code/sample/SampleApps/WebView2WpfBrowser/MainWindow.xaml.cs" id="SubscribeToBrowserProcessExited":::
|
:::code language="csharp" source="../code/sample/SampleApps/WebView2WpfBrowser/MainWindow.xaml.cs" id="BrowserProcessExited":::
|
</example>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreatePrintSettings">
|
<summary>
|
Creates the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings" /> used by the <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfAsync(System.String,Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> method.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Environment.UserDataFolder">
|
<summary>
|
Gets the user data folder that all CoreWebView2s created from this environment are using.
|
</summary><remarks>
|
This could be either the value passed in by the developer when creating the environment object or the calculated one for default handling. And will always be an absolute path.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Environment.ProcessInfosChanged">
|
<summary>
|
ProcessInfosChanged is raised when a collection of WebView2 Runtime processes changed due to new process being detected or when a existing process gone away.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.GetProcessInfos">
|
<summary>
|
Returns the list of all <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessInfo" /> using same user data folder except for crashpad process.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateContextMenuItem(System.String,System.IO.Stream,Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItemKind)">
|
<summary>
|
Create a custom <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem" /> object to insert into the WebView context menu.
|
</summary><remarks>
|
CoreWebView2 will rewind the <c>icon</c> stream before decoding.
|
There is a limit of 1000 active custom context menu items at a given time per <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment" />. Attempting to create more before deleting existing ones will fail with <c>ERROR_NOT_ENOUGH_QUOTA</c>. It is recommended to reuse custom ContextMenuItems across CoreWebView2ContextMenuRequested events for performance. The created object's <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.IsEnabled" /> property will default to <c>true</c> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.IsChecked" /> property will default to <c>false</c>. A <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ContextMenuItem.CommandId" /> will be assigned that's unique across active custom context menu items, but command ID values of deleted custom ContextMenuItems can be reassigned.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateAsync(System.String,System.String,Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions)">
|
<summary>
|
Creates a WebView2 Environment using the installed or a custom WebView2 Runtime version.
|
</summary>
|
<param name="browserExecutableFolder">
|
The relative path to the folder that contains a custom version of WebView2 Runtime.
|
<para>
|
To use a fixed version of the WebView2 Runtime, pass the
|
folder path that contains the fixed version of the WebView2 Runtime
|
to <c>browserExecutableFolder</c>. BrowserExecutableFolder supports both relative
|
(to the application's executable) and absolute file paths. To create WebView2 controls
|
that use the installed version of the WebView2 Runtime that exists on
|
user machines, pass a <c>null</c> or empty string to
|
<c>browserExecutableFolder</c>. In this scenario, the API tries to
|
find a compatible version of the WebView2 Runtime that is installed
|
on the user machine (first at the machine level, and then per user)
|
using the selected channel preference. The path of fixed version of
|
the WebView2 Runtime should not contain <em>\Edge\Application\</em>. When
|
such a path is used, the API fails with <c>ERROR_NOT_SUPPORTED</c>.
|
</para>
|
</param>
|
<param name="userDataFolder">
|
The user data folder location for WebView2.
|
<para>
|
The path is either an absolute file path or a relative file path
|
that is interpreted as relative to the compiled code for the
|
current process. The default user data folder <em>{Executable File
|
Name}.WebView2</em> is created in the same directory next to the
|
compiled code for the app. WebView2 creation fails if the compiled
|
code is running in a directory in which the process does not have
|
permission to create a new directory. The app is responsible to
|
clean up the associated user data folder when it is done.
|
</para>
|
</param>
|
<param name="options">
|
Options used to create WebView2 Environment.
|
<para>
|
As a browser process may be shared among WebViews, WebView creation
|
fails if the specified <c>options</c> does not match the options of
|
the WebViews that are currently running in the shared browser
|
process.
|
</para>
|
</param>
|
<remarks>
|
<para>
|
The default channel search order is the WebView2 Runtime, Beta, Dev, and
|
Canary. When an override <c>WEBVIEW2_RELEASE_CHANNEL_PREFERENCE</c> environment
|
variable or applicable <c>releaseChannelPreference</c> registry value is set to
|
<c>1</c>, the channel search order is reversed.
|
</para>
|
<para>
|
To use a fixed version of the WebView2 Runtime, pass the relative
|
folder path that contains the fixed version of the WebView2 Runtime
|
to <c>browserExecutableFolder</c>. To create WebView2 controls that
|
use the installed version of the WebView2 Runtime that exists on
|
user machines, pass a <c>null</c> or empty string to
|
<c>browserExecutableFolder</c>. In this scenario, the API tries to
|
find a compatible version of the WebView2 Runtime that is installed
|
on the user machine (first at the machine level, and then per user)
|
using the selected channel preference. The path of fixed version of
|
the WebView2 Runtime should not contain <em>\Edge\Application\</em>. When
|
such a path is used, the API fails with the following error.
|
</para>
|
<para>
|
The <paramref name="browserExecutableFolder"/>, <paramref
|
name="userDataFolder"/>, and <paramref name="options"/> may be
|
overridden by values either specified in environment variables or in
|
the registry.
|
</para>
|
<para>
|
When creating a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment"/> the following environment variables are verified.
|
</para>
|
<list type="bullet">
|
<item>
|
<term><c>WEBVIEW2_BROWSER_EXECUTABLE_FOLDER</c></term>
|
</item>
|
<item>
|
<term><c>WEBVIEW2_USER_DATA_FOLDER</c></term>
|
</item>
|
<item>
|
<term><c>WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS</c></term>
|
</item>
|
<item>
|
<term><c>WEBVIEW2_RELEASE_CHANNEL_PREFERENCE</c></term>
|
</item>
|
</list>
|
<para>
|
If browser executable folder or user data folder is specified in an
|
environment variable or in the registry, the specified <paramref
|
name="browserExecutableFolder"/> or <paramref
|
name="userDataFolder"/> values are overridden. If additional browser
|
arguments are specified in an environment variable or in the
|
registry, it is appended to the corresponding value in the specified
|
<paramref name="options"/>.
|
</para>
|
<para>
|
While not strictly overrides, additional environment variables may be set.
|
</para>
|
<list type="table">
|
<listheader>
|
<term>Value</term>
|
<description>Description</description>
|
</listheader>
|
<item>
|
<term><c>WEBVIEW2_WAIT_FOR_SCRIPT_DEBUGGER</c></term>
|
<description>
|
When found with a non-empty value, this indicates that the WebView
|
is being launched under a script debugger. In this case, the WebView
|
issues a <c>Page.waitForDebugger</c> CDP command that runs the
|
script inside the WebView to pause on launch, until a debugger
|
issues a corresponding <c>Runtime.runIfWaitingForDebugger</c> CDP
|
command to resume the runtime.
|
Note that this environment variable does not have a registry key equivalent.
|
</description>
|
</item>
|
<item>
|
<term><c>WEBVIEW2_PIPE_FOR_SCRIPT_DEBUGGER</c></term>
|
<description>
|
When found with a non-empty value, it indicates that the WebView is
|
being launched under a script debugger that also supports host apps
|
that use multiple WebViews. The value is used as the identifier for
|
a named pipe that is opened and written to when a new WebView is
|
created by the host app. The payload should match the payload of the
|
<c>remote-debugging-port</c> JSON target and an external debugger
|
may use it to attach to a specific WebView instance. The format of
|
the pipe created by the debugger should be
|
<c>\\.\pipe\WebView2\Debugger\{app_name}\{pipe_name}</c>, where the
|
following are true.
|
|
<list type="bullet">
|
<item><description><c>{app_name}</c> is the host app exe file name, for example, <c>WebView2Example.exe</c></description></item>
|
<item><description><c>{pipe_name}</c> is the value set for <c>WEBVIEW2_PIPE_FOR_SCRIPT_DEBUGGER</c></description></item>
|
</list>
|
|
To enable debugging of the targets identified by the JSON, you must
|
set the <c>WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS</c> environment
|
variable to send <c>--remote-debugging-port={port_num}</c>, where
|
the following is true.
|
|
<list type="bullet">
|
<item><description><c>{port_num}</c> is the port on which the CDP server binds.</description></item>
|
</list>
|
|
If both <c>WEBVIEW2_PIPE_FOR_SCRIPT_DEBUGGER</c> and
|
<c>WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS</c> environment variables,
|
the WebViews hosted in your app and associated contents may exposed
|
to 3rd party apps such as debuggers. Note that this environment
|
variable does not have a registry key equivalent.
|
</description>
|
</item>
|
</list>
|
<para>
|
If none of those environment variables exist, then the registry is examined
|
next.
|
</para>
|
<list type="bullet">
|
<item>
|
<term><c>[{Root}]\Software\Policies\Microsoft\Edge\WebView2\BrowserExecutableFolder "{AppId}"=""</c></term>
|
</item>
|
<item>
|
<term><c>[{Root}]\Software\Policies\Microsoft\Edge\WebView2\ReleaseChannelPreference "{AppId}"=""</c></term>
|
</item>
|
<item>
|
<term><c>[{Root}]\Software\Policies\Microsoft\Edge\WebView2\AdditionalBrowserArguments "{AppId}"=""</c></term>
|
</item>
|
<item>
|
<term><c>[{Root}]\Software\Policies\Microsoft\Edge\WebView2\UserDataFolder "{AppId}"=""</c></term>
|
</item>
|
</list>
|
<para>
|
Use a group policy under <strong>Administrative Templates</strong> >
|
<strong>Microsoft Edge WebView2</strong> to configure browser executable folder
|
and release channel preference.
|
</para>
|
<list type="table">
|
<listheader>
|
<term>Value</term>
|
<description>Description</description>
|
</listheader>
|
<item>
|
<term><c>ERROR_DISK_FULL</c></term>
|
<description>
|
In the unlikely scenario where some instances of WebView are open during a
|
browser update, the deletion of the previous WebView2 Runtime may be
|
blocked. To avoid running out of disk space, a new WebView creation fails
|
with this error if it detects that too many previous WebView2
|
Runtime versions exist.
|
</description>
|
</item>
|
<item>
|
<term><c>COREWEBVIEW2_MAX_INSTANCES</c></term>
|
<description>
|
The default maximum number of WebView2 Runtime versions allowed is <c>20</c>.
|
To override the maximum number of the previous WebView2 Runtime versions
|
allowed, set the value of the following environment variable.
|
</description>
|
</item>
|
<item>
|
<term><c>ERROR_PRODUCT_UNINSTALLED</c></term>
|
<description>
|
If the Webview depends upon an installed WebView2 Runtime version and it is
|
uninstalled, any subsequent creation fails with this error.
|
</description>
|
</item>
|
</list>
|
<para>
|
First verify with Root as <c>HKLM</c> and then <c>HKCU</c>. <c>AppId</c> is first set to
|
the Application User Model ID of the process, then if no corresponding
|
registry key, the <c>AppId</c> is set to the compiled code name of the process,
|
or if that is not a registry key then <c>*</c>. If an override registry key is
|
found, use the <c>browserExecutableFolder</c> and <c>userDataFolder</c> registry
|
values as replacements and append <c>additionalBrowserArguments</c> registry
|
values for the corresponding values in the provided <paramref name="options"/>.
|
</para>
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.GetAvailableBrowserVersionString(System.String)">
|
<summary>
|
Gets the browser version info including channel name if it is not the stable channel or WebView2 Runtime.
|
</summary>
|
<param name="browserExecutableFolder">
|
The relative path to the folder that contains the WebView2 Runtime.
|
</param>
|
<exception cref="T:Microsoft.Web.WebView2.Core.WebView2RuntimeNotFoundException">
|
WebView2 Runtime installation is missing.
|
</exception>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.GetAvailableBrowserVersionString(System.String,Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions)">
|
<summary>
|
Gets the browser version info including channel name if it is not the stable channel or WebView2 Runtime.
|
</summary>
|
<param name="browserExecutableFolder">
|
The relative path to the folder that contains the WebView2 Runtime.
|
</param>
|
<param name="environmentOptions">
|
The environment options used to create the environment.
|
</param>
|
<exception cref="T:Microsoft.Web.WebView2.Core.WebView2RuntimeNotFoundException">
|
WebView2 Runtime installation is missing.
|
</exception>
|
<remarks>
|
Browser version info includes channel name if it is not the WebView2 Runtime.
|
Channel names are Beta, Dev, and Canary. The format of the return string
|
matches the format of <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Environment.BrowserVersionString"/>.
|
If an override exists for <c>BrowserExecutableFolder</c>, <c>ReleaseChannels</c>,
|
or <c>ChannelSearchKind</c>, the override is used. The presence of an override
|
can result in a different channel used than the one expected based on the environment
|
options object. <c>BrowserExecutableFolder</c> takes precedence over the
|
other options. See <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2EnvironmentWithOptions(System.String,System.String,Microsoft.Web.WebView2.Core.Raw.ICoreWebView2EnvironmentOptions,Microsoft.Web.WebView2.Core.Raw.ICoreWebView2CreateCoreWebView2EnvironmentCompletedHandler)"/>
|
for more details on overrides. If an override is not specified, then the
|
parameters passed to <c>GetAvailableBrowserVersionString</c> are used.
|
The method fails if the loader is unable to find an installed WebView2
|
Runtime or non-stable Microsoft Edge installation.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CompareBrowserVersions(System.String,System.String)">
|
<summary>
|
Compares two instances of browser versions correctly and returns an integer that indicates whether the first instance is older, the same as, or newer than the second instance.
|
</summary>
|
<param name="version1">
|
One of the version strings to compare.
|
</param>
|
<param name="version2">
|
The other version string to compare.
|
</param>
|
<returns>
|
An integer that indicates whether the first instance is older, the same as, or newer than the second instance.
|
<list type="table">
|
<listheader>
|
<description>Value Type</description>
|
<description>Condition</description>
|
</listheader>
|
<item>
|
<description>Less than zero</description>
|
<description><c>version1</c> is older than <c>version2</c>.</description>
|
</item>
|
<item>
|
<description>Zero</description>
|
<description><c>version1</c> is the same as <c>version2</c>.</description>
|
</item>
|
<item>
|
<description>Greater than zero</description>
|
<description><c>version1</c> is newer than <c>version2</c>.</description>
|
</item>
|
</list>
|
</returns>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2ControllerOptions">
|
<summary>
|
Creates a new <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions"/> object,
|
which can be passed as a parameter in <see
|
cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2ControllerAsync(System.IntPtr,Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions)"/> and <see
|
cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2CompositionControllerAsync(System.IntPtr,Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions)"/> function for multiple profiles
|
support.
|
</summary>
|
<returns>
|
A <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions"/> that can be
|
passed when calling <see
|
cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2ControllerAsync(System.IntPtr,Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions)"/> and <see
|
cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateCoreWebView2CompositionControllerAsync(System.IntPtr,Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions)"/>.
|
</returns>
|
<remarks>
|
The options is a settable property while the default for profile
|
name is an empty string and the default value for <see
|
cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions.IsInPrivateModeEnabled"/> is
|
false. The profile will be created on disk or opened when calling
|
CreateCoreWebView2ControllerWithOptions no matter InPrivate mode is
|
enabled or not, and it will be released in memory when the
|
corresponding <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Controller"/> is closed but
|
still remain on disk. As WebView2 is built on top of Edge browser,
|
it follows Edge's behavior pattern. To create an InPrivate WebView,
|
we get an off-the-record profile (an InPrivate profile) from a
|
regular profile, then create the WebView with the off-the-record
|
profile. Also the profile name can be reused.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.SetLoaderDllFolderPath(System.String)">
|
<summary>
|
Set the path of the folder containing the `WebView2Loader.dll`.
|
</summary>
|
<param name="folderPath">The path of the folder containing the `WebView2Loader.dll`.</param>
|
<exception cref="T:System.InvalidOperationException">
|
Thrown when `WebView2Loader.dll` has been successfully loaded.
|
</exception>
|
<remarks>
|
This function allows you to set the path of the folder containing the `WebView2Loader.dll`. This should be the path of a folder containing `WebView2Loader.dll` and not a path to the `WebView2Loader.dll` file itself.
|
Note that the WebView2 SDK contains multiple `WebView2Loader.dll` files for different CPU architectures. When specifying folder path, you must specify one containing a `WebView2Loader.dll` module with a CPU architecture matching the current process CPU architecture.
|
This function is used to load the `WebView2Loader.dll` module during calls to any other static methods on `CoreWebView2Environment`. So, the path should be specified before any other API is called in `CoreWebView2Environment` class. Once `WebView2Loader.dll` is successfully loaded this function will throw an InvalidOperationException exception.
|
The path can be relative or absolute. Relative paths are relative to the path of the `Microsoft.Web.WebView2.Core.dll` module.
|
If the `WebView2Loader.dll` file does not exist in that path or LoadLibrary cannot load the file, or LoadLibrary fails for any other reason, an exception corresponding to the LoadLibrary failure is thrown when any other API is called in `CoreWebView2Environment` class. For instance, if the file cannot be found a `DllNotFoundException` exception will be thrown.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions">
|
<summary>
|
Options used to create WebView2 Environment.
|
Default values will use your defaulted Edge WebView2 Runtime binaries and user data folder.</summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary>
|
Options used to create WebView2 Environment.
|
</summary>
|
<remarks>
|
Default values will use your defaulted Edge WebView2 Runtime binaries and
|
user data folder.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.AdditionalBrowserArguments">
|
<summary>
|
Gets or sets the additional browser arguments to change the behavior of the WebView.
|
</summary><remarks><para>
|
The arguments are passed to the browser process as part of the command. For more information about using command-line switches with Chromium browser processes, navigate to [Run Chromium with Flags](https://aka.ms/RunChromiumWithFlags). The value appended to a switch is appended to the browser process, for example, in <c>--edge-webview-switches=xxx</c> the value is <c>xxx</c>. If you specify a switch that is important to WebView functionality, it is ignored, for example, <c>--user-data-dir</c>. Specific features are disabled internally and blocked from being enabled. If a switch is specified multiple times, only the last instance is used.
|
</para><para>
|
A merge of the different values of the same switch is not attempted, except for disabled and enabled features. The features specified by <c>--enable-features</c> and <c>--disable-features</c> will be merged with simple logic -- the features are the union of the specified features and built-in features. If a feature is disabled, it is removed from the enabled features list.
|
</para><para>
|
If you specify command-line switches and sets this property, the <c>--edge-webview-switches</c> value takes precedence and is processed last. If a switch fails to parse, the switch is ignored. The default state for the operation is to run the browser process with no extra flags.
|
</para><para>
|
Please note that calling this API twice will replace the previous value rather than appending to it. If there are multiple switches, there should be a space in between them. The one exception is if multiple features are being enabled/disabled for a single switch, in which case the features should be comma-separated. Ex. "--disable-features=feature1,feature2 --some-other-switch --do-something"
|
</para></remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.AllowSingleSignOnUsingOSPrimaryAccount">
|
<summary>
|
Determines whether to enable single sign on with Azure Active Directory (AAD) resources inside WebView using the logged in Windows account and single sign on (SSO) with web sites using Microsoft account associated with the login in Windows account.
|
</summary><remarks>
|
The default value is <c>false</c>. Universal Windows Platform apps must also declare <c>enterpriseCloudSSO</c> [restricted capability](/windows/uwp/packaging/app-capability-declarations#restricted-capabilities) for the single sign on (SSO) to work.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.Language">
|
<summary>
|
Gets or sets the default display language for WebView.
|
</summary><remarks>
|
It applies to browser UIs such as context menu and dialogs. It also applies to the <c>accept-languages</c> HTTP header that WebView sends to websites. The intended locale value is in the format of BCP 47 Language Tags. More information can be found from [IETF BCP47](https://www.ietf.org/rfc/bcp/bcp47.html).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.TargetCompatibleBrowserVersion">
|
<summary>
|
Gets or sets the version of the WebView2 Runtime binaries required to be compatible with your app.
|
</summary><remarks>
|
This defaults to the WebView2 Runtime version that corresponds with the version of the SDK the app is using. The format of this value is the same as the format of the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Environment.BrowserVersionString" /> property and other BrowserVersion values. Only the version part of the BrowserVersion value is respected. The channel suffix, if it exists, is ignored. The version of the WebView2 Runtime binaries actually used may be different from the specified TargetCompatibleBrowserVersion. The binaries are only guaranteed to be compatible. Verify the actual version on the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Environment.BrowserVersionString" /> property.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.ExclusiveUserDataFolderAccess">
|
<summary>
|
Determines whether other processes can create <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Controller" /> from <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment" /> created with the same user data folder and therefore sharing the same WebView browser process instance.
|
</summary><remarks>
|
The default value is <c>false</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.IsCustomCrashReportingEnabled">
|
<summary>
|
When <c>IsCustomCrashReportingEnabled</c> is set to <c>true</c>, Windows won't send crash data to Microsoft endpoint.
|
</summary><remarks>
|
The default value is <c>false</c>. In this case, WebView will respect OS consent.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.EnableTrackingPrevention">
|
<summary>
|
The <c>EnableTrackingPrevention</c> property is used to enable/disable tracking prevention feature in WebView2. This property enable/disable tracking prevention for all the WebView2's created in the same environment. By default this feature is enabled to block potentially harmful trackers and trackers from sites that aren't visited before and set to <c>CoreWebView2TrackingPreventionLevel.Balanced</c> or whatever value was last changed/persisted on the profile.
|
</summary><remarks>
|
You can set this property to false to disable the tracking prevention feature if the app only renders content in the WebView2 that is known to be safe. Disabling this feature when creating environment also improves runtime performance by skipping related code.
|
|
You shouldn't disable this property if WebView2 is being used as a "full browser" with arbitrary navigation and should protect end user privacy.
|
|
There is <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.PreferredTrackingPreventionLevel" /> property to control levels of tracking prevention of the WebView2's associated with a same profile. However, you can also disable tracking prevention later using <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.PreferredTrackingPreventionLevel" /> property and <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2TrackingPreventionLevel.None" /> value but that doesn't improves runtime performance.
|
|
See <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.PreferredTrackingPreventionLevel" /> for more details.
|
|
Tracking prevention protects users from online tracking by restricting the ability of trackers to access browser-based storage as well as the network. See [Tracking prevention](/microsoft-edge/web-platform/tracking-prevention).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.AreBrowserExtensionsEnabled">
|
<summary>
|
Enable/disable browser extensions.
|
</summary><remarks>
|
When <c>AreBrowserExtensionsEnabled</c> is set to <c>true</c>, new extensions can be added to user profile and used. <c>AreBrowserExtensionsEnabled</c> is default to be <c>false</c>, in this case, new extensions can't be installed, and already installed extension won't be available to use in user profile. If connecting to an already running environment with a different value for <c>AreBrowserExtensionsEnabled</c> property, it will fail with <c>HRESULT_FROM_WIN32(ERROR_INVALID_STATE)</c>. See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2BrowserExtension" /> for Extensions API details.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.ScrollBarStyle">
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.ChannelSearchKind">
|
<summary>
|
Set <c>ChannelSearchKind</c> to <c>CoreWebView2ChannelSearchKind.LeastStable</c> so that the WebView2 loader searches for binaries from least to most stable: Canary -> Dev -> Beta -> WebView2 Runtime.
|
</summary><remarks>
|
The <c>ChannelSearchKind</c> property is <c>CoreWebView2ChannelSearchKind.MostStable</c> by default and environment creation searches for a release channel on the machine from most to least stable using the first channel found. The default search order is: WebView2 Release -> Beta -> Dev -> Canary. Set <c>ChannelSearchKind</c> to <c>CoreWebView2ChannelSearchKind.LeastStable</c> to reverse the search order so that environment creation searches for a channel from least to most stable. If a <c>ReleaseChannels</c> has been provided, environment creation will only search for channels in the set. See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ReleaseChannels" /> for more details on channels. This property can be overridden by the corresponding registry key <c>ChannelSearchKind</c> or the environment variable <c>WEBVIEW2_CHANNEL_SEARCH_KIND</c>. Set the value to <c>1</c> to reverse the search order. See <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateAsync(System.String,System.String,Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions)" /> for more details on overrides.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.ReleaseChannels">
|
<summary>
|
Sets the <c>ReleaseChannels</c>, which is a mask of one or more <c>CoreWebView2ReleaseChannels</c> indicating which channels environment creation should search for.</summary><remarks>
|
OR operation(s) can be applied to multiple <c>CoreWebView2ReleaseChannels</c> to create a mask. The default value is a mask of all the channels. By default, environment creation searches for channels from most to least stable, using the first channel found on the device. When <c>ReleaseChannels</c> is provided, environment creation will only search for the channels specified in the set. Set <c>ChannelSearchKind</c> to <c>CoreWebView2ChannelSearchKind.LeastStable</c> to reverse the search order so that environment creation searches for the least stable build first. See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ReleaseChannels" /> for descriptions of each channel. Environment creation fails if it is unable to find any channel from the <c>ReleaseChannels</c> installed on the device. Use <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.GetAvailableBrowserVersionString(System.String,Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions)" /> to verify which channel is used. If both a <c>BrowserExecutableFolder</c> and <c>ReleaseChannels</c> are provided, the <c>BrowserExecutableFolder</c> takes precedence. The <c>ReleaseChannels</c> can be overridden by the corresponding registry override <c>ReleaseChannels</c> or the environment variable <c>WEBVIEW2_RELEASE_CHANNELS</c>. Set the value to a comma-separated string of integers, which map to the following release channel values: Stable (0), Beta (1), Dev (2), and Canary (3). For example, the values "0,2" and "2,0" indicate that environment creation should only search for Dev channel and the WebView2 Runtime, using the order indicated by <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.ChannelSearchKind" />. Environment creation attempts to interpret each integer and treats any invalid entry as Stable channel.
|
<list type="table"><listheader><description>ReleaseChannels</description><description>Channel Search Kind: Most Stable (default)</description><description>Channel Search Kind: Least Stable</description></listheader><item><description>CoreWebView2ReleaseChannels.Beta | CoreWebView2ReleaseChannels.Stable</description><description>WebView2 Runtime -> Beta</description><description>Beta -> WebView2 Runtime</description></item><item><description>CoreWebView2ReleaseChannels.Canary | CoreWebView2ReleaseChannels.Dev | CoreWebView2ReleaseChannels.Beta | CoreWebView2ReleaseChannels.Stable</description><description>WebView2 Runtime -> Beta -> Dev -> Canary</description><description>Canary -> Dev -> Beta -> WebView2 Runtime</description></item><item><description>CoreWebView2ReleaseChannels.Canary</description><description>Canary</description><description>Canary</description></item><item><description>CoreWebView2ReleaseChannels.Beta | CoreWebView2ReleaseChannels.Canary | CoreWebView2ReleaseChannels.Stable</description><description>WebView2 Runtime -> Beta -> Canary</description><description>Canary -> Beta -> WebView2 Runtime</description></item></list></remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.#ctor(System.String,System.String,System.String,System.Boolean,System.Collections.Generic.List{Microsoft.Web.WebView2.Core.CoreWebView2CustomSchemeRegistration})">
|
<summary>
|
Initializes a new instance of the CoreWebView2EnvironmentOptions class.
|
</summary>
|
<param name="additionalBrowserArguments">
|
AdditionalBrowserArguments can be specified to change the behavior of
|
the WebView.
|
</param>
|
<param name="language">
|
The default language that WebView will run with.
|
</param>
|
<param name="targetCompatibleBrowserVersion">
|
The version of the Edge WebView2 Runtime binaries required to be
|
compatible with the calling application.
|
</param>
|
<param name="allowSingleSignOnUsingOSPrimaryAccount">
|
Set to true if single sign on be enabled using the end user's OS primary
|
account. Defaults to false.
|
</param>
|
<param name="customSchemeRegistrations">
|
List of custom scheme registrations to be applied to the <see
|
cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment"/>.
|
</param>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.#ctor(System.String,System.String,System.String,System.Boolean,System.Collections.Generic.List{Microsoft.Web.WebView2.Core.CoreWebView2CustomSchemeRegistration},Microsoft.Web.WebView2.Core.CoreWebView2ReleaseChannels,Microsoft.Web.WebView2.Core.CoreWebView2ChannelSearchKind)">
|
<summary>
|
Initializes a new instance of the CoreWebView2EnvironmentOptions class.
|
</summary>
|
<param name="additionalBrowserArguments">
|
AdditionalBrowserArguments can be specified to change the behavior of
|
the WebView.
|
</param>
|
<param name="language">
|
The default language that WebView will run with.
|
</param>
|
<param name="targetCompatibleBrowserVersion">
|
The version of the Edge WebView2 Runtime binaries required to be
|
compatible with the calling application.
|
</param>
|
<param name="allowSingleSignOnUsingOSPrimaryAccount">
|
Set to true if single sign on be enabled using the end user's OS primary
|
account. Defaults to false.
|
</param>
|
<param name="customSchemeRegistrations">
|
List of custom scheme registrations to be applied to the <see
|
cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment"/>.
|
</param>
|
<param name="channelSearchKind">
|
Set to CoreWebView2ChannelSearchKind.LeastStable so that environment
|
creation searches for binaries from least to most stable:
|
Canary -> Dev -> Beta -> WebView2 Runtime.
|
Defaults to CoreWebView2RuntimeChannel.MostStable.
|
</param>
|
<param name="releaseChannels">
|
The release channels that are searched for during environment creation.
|
</param>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.CustomSchemeRegistrations">
|
<summary>
|
List of custom scheme registrations to be applied to the <see
|
cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment"/>
|
</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ExecuteScriptResult">
|
<summary>
|
The result for <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.ExecuteScriptWithResultAsync(System.String)" />.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ExecuteScriptResult.Exception">
|
<summary>
|
If Succeeded is false, you can use this property to get the unhandled exception thrown by script execution</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ExecuteScriptResult.ResultAsJson">
|
<summary>
|
A function that has no explicit return value returns undefined. If the script that was run throws an unhandled exception, then the result is also null.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ExecuteScriptResult.Succeeded">
|
<summary>
|
This property is true if <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.ExecuteScriptWithResultAsync(System.String)" /> successfully executed script with no unhandled exceptions and the result is available in the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ExecuteScriptResult.ResultAsJson" /> property.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2ExecuteScriptResult.TryGetResultAsString(System.String@,System.Int32@)">
|
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2File">
|
<summary>
|
Representation of a DOM [File](https://developer.mozilla.org/docs/Web/API/File) object passed via WebMessage.
|
</summary><remarks>
|
You can use this object to obtain the path of a File dropped on WebView2.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2File.Path">
|
<summary>
|
The absolute file path.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandle">
|
<summary>Representation of a DOM
|
[FileSystemHandle](https://developer.mozilla.org/docs/Web/API/FileSystemHandle)
|
object.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandle.Kind">
|
<summary>The kind of the FileSystemHandle. It can either be a file or a directory.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandle.Path">
|
<summary>The path to the FileSystemHandle.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2FileSystemHandle.Permission">
|
<summary>The permissions granted to the FileSystemHandle.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2Frame">
|
<summary>
|
CoreWebView2Frame provides direct access to the iframes information and handling. You can get a CoreWebView2Frame by handling the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.FrameCreated" /> event.</summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary>
|
CoreWebView2Frame provides direct access to the iframes information and handling.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Frame.Name">
|
<summary>
|
The name of the iframe from the iframe html tag declaring it.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.Destroyed">
|
<summary>
|
Destroyed event is raised when the iframe corresponding to this <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Frame" /> object is removed or the document containing that iframe is destroyed.
|
</summary><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.RemoveHostObjectFromScript(System.String)" />
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.NameChanged">
|
<summary>
|
NameChanged is raised when the iframe changes its <c>window.name</c> property.
|
</summary><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.RemoveHostObjectFromScript(System.String)" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Frame.RemoveHostObjectFromScript(System.String)">
|
<summary>
|
Remove the host object specified by the name so that it is no longer accessible from JavaScript code in the iframe.
|
</summary><remarks>
|
While new access attempts are denied, if the object is already obtained by JavaScript code in the iframe, the JavaScript code continues to have access to that object. Calling this method for a name that is already removed or was never added fails. If the iframe is destroyed this method will return fail also.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Frame.IsDestroyed">
|
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.ContentLoading">
|
<summary>
|
ContentLoading is raised before any content is loaded, including scripts added with <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddScriptToExecuteOnDocumentCreatedAsync(System.String)" />. ContentLoading is not raised if a same page navigation occurs.
|
</summary><remarks>
|
This operation follows the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.NavigationStarting" /> event and precedes the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.DOMContentLoaded" /> and <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.NavigationCompleted" /> events.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.DOMContentLoaded">
|
<summary>
|
DOMContentLoaded is raised when the initial HTML document has been parsed.
|
</summary><remarks>
|
This aligns with the the document's <c>DOMContentLoaded</c> event in HTML.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.NavigationCompleted">
|
<summary>
|
NavigationCompleted is raised when the current frame has completely loaded (<c>body.onload</c> has been raised) or loading stopped with error.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.NavigationStarting">
|
<summary>
|
NavigationStarting is raised when the current frame is requesting permission to navigate to a different URI.
|
</summary><remarks>
|
A frame navigation will raise a <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.NavigationStarting" /> event and a <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.FrameNavigationStarting" /> event. All of the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.FrameNavigationStarting" /> event handlers will be run before the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.NavigationStarting" /> event handlers. All of the event handlers share a common <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs" /> object. Whichever event handler is last to change the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs.Cancel" /> property will decide if the frame navigation will be cancelled.
|
Redirects raise this event as well, and the navigation id is the same as the original one. You may block corresponding navigations until the event handler returns.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.WebMessageReceived">
|
<summary>
|
WebMessageReceived is raised when the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsWebMessageEnabled" /> setting is set and the iframe runs <c>window.chrome.webview.postMessage</c>.
|
</summary><remarks>
|
The <c>postMessage</c> function is <c>void postMessage(object)</c> where object is any object supported by JSON conversion.
|
When <c>postMessage</c> is called, the handler's Invoke method will be called with the <c>object</c> parameter <c>postMessage</c> converted to a JSON string.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Frame.ExecuteScriptAsync(System.String)">
|
<summary>
|
Runs JavaScript code from the <c>javaScript</c> parameter in the current frame.
|
</summary><param name="javaScript">The JavaScript code to be run in the current frame.</param><returns>A JSON encoded string that represents the result of running the provided JavaScript.</returns><remarks>
|
A function that has no explicit return value returns <c>undefined</c>. If the script that was run throws an unhandled exception, then the result is also <c>null</c>. This method is applied asynchronously.
|
If the method is run before <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.ContentLoading" />, the script will not be executed and the JSON <c>null</c> will be returned.
|
This operation works even if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsScriptEnabled" /> is set to <c>false</c>.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Frame.PostWebMessageAsJson(System.String)">
|
<summary>
|
Posts the specified <c>webMessageAsJson</c> to the current frame.
|
</summary><param name="webMessageAsJson">The web message to be posted to the iframe.</param><remarks>
|
The event args is an instance of <c>MessageEvent</c>. The <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsWebMessageEnabled" /> setting must be <c>true</c> or the message will not be sent. The event arg's <c>data</c> property of the event arg is the <c>webMessageAsJson</c> string parameter parsed as a JSON string into a JavaScript object. The event arg's <c>source</c> property of the event arg is a reference to the <c>window.chrome.webview</c> object. For information about sending messages from the iframe to the host, navigate to <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.WebMessageReceived" />. The message is sent asynchronously. If a navigation occurs before the message is posted to the iframe, the message is not be sent.
|
</remarks><example>
|
Runs the message event of the <c>window.chrome.webview</c> of the iframe. JavaScript in that document may subscribe and unsubscribe to the event using the following code:
|
```javascript
|
window.chrome.webview.addEventListener('message', handler)
|
window.chrome.webview.removeEventListener('message', handler)
|
```
|
</example><seealso cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsWebMessageEnabled" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.WebMessageReceived" /><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Frame.PostWebMessageAsString(System.String)" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Frame.PostWebMessageAsString(System.String)">
|
<summary>
|
Posts a message that is a simple string rather than a JSON string representation of a JavaScript object.
|
</summary><param name="webMessageAsString">The web message to be posted to the iframe.</param><remarks>
|
This behaves in exactly the same manner as <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Frame.PostWebMessageAsJson(System.String)" />, but the <c>data</c> property of the event arg of the <c>window.chrome.webview</c> message is a string with the same value as <c>webMessageAsString</c>. Use this instead of <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Frame.PostWebMessageAsJson(System.String)" /> if you want to communicate using simple strings rather than JSON objects.
|
</remarks><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.WebMessageReceived" /><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Frame.PostWebMessageAsJson(System.String)" />
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.PermissionRequested">
|
<summary>
|
PermissionRequested is raised when content in an iframe or any of its descendant iframes requests permission to access some privileged resources.
|
</summary><remarks>
|
This relates to the <c>PermissionRequested</c> event on the <c>CoreWebView2</c>.
|
Both these events will be raised in the case of an iframe requesting permission. The <c>CoreWebView2Frame</c>'s event handlers will be invoked before the event handlers on the <c>CoreWebView2</c>. If the <c>Handled</c> property of the <c>PermissionRequestedEventArgs</c> is set to TRUE within the <c>CoreWebView2Frame</c> event handler, then the event will not be raised on the <c>CoreWebView2</c>, and it's event handlers will not be invoked.
|
In the case of nested iframes, the <c>PermissionRequested</c> event will be raised from the top level iframe.
|
If a deferral is not taken on the event args, the subsequent scripts are blocked until the event handler returns. If a deferral is taken, the scripts are blocked until the deferral is completed.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Frame.PostSharedBufferToScript(Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer,Microsoft.Web.WebView2.Core.CoreWebView2SharedBufferAccess,System.String)">
|
<summary>
|
Share a shared buffer object with script of the iframe in the WebView.
|
</summary><param name="sharedBuffer">The <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer" /> object to be shared with script.</param><param name="access">The desired <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2SharedBufferAccess" /> given to script.</param><param name="additionalDataAsJson">Additional data to be send to script. If it is not null or empty string, and it is not a valid JSON string, <see cref="T:System.ArgumentException" /> will be thrown.</param><remarks>
|
The script will receive a <c>sharedbufferreceived</c> event from chrome.webview.
|
The event arg for that event will have the following methods and properties.
|
|
<list type="table"><listheader><description>Property</description><description>Description</description></listheader><item><description><c>getBuffer()</c></description><description>A method that returns an ArrayBuffer object with the backing content from the shared buffer.</description></item><item><description><c>additionalData</c></description><description>An object as the result of parsing <c>additionalDataAsJson</c> as JSON string. This property will be <c>undefined</c> if <c>additionalDataAsJson</c> is nullptr or empty string.</description></item><item><description><c>source</c></description><description>With a value set as <c>chrome.webview</c> object.</description></item></list>
|
|
If <c>access</c> is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2SharedBufferAccess.ReadOnly" />, the script will only have read access to the buffer.
|
If the script tries to modify the content in a read only buffer, it will cause an access violation in WebView renderer process and crash the renderer process.
|
|
If the shared buffer is already closed, the API throws <see cref="T:System.Runtime.InteropServices.COMException" /> with error code of <c>RO_E_CLOSED</c>.
|
The script code should call <c>chrome.webview.releaseBuffer</c> with the shared buffer as the parameter to release underlying resources as soon as it does not need access to the shared buffer any more.
|
|
The application can post the same shared buffer object to multiple web pages or iframes, or post to the same web page or iframe multiple times.
|
Each <c>PostSharedBufferToScript</c> will create a separate ArrayBuffer object with its own view of the memory and is separately released.
|
The underlying shared memory will be released when all the views are released.
|
|
Sharing a buffer to script has security risk. You should only share buffer with trusted site.
|
If a buffer is shared to a untrusted site, possible sensitive information could be leaked.
|
If a buffer is shared as modifiable by the script and the script modifies it in an unexpected way, it could result in corrupted data that might even crash the application.
|
|
The example code shows how to send data to script for one time read only consumption.
|
</remarks><example>
|
:::code language="csharp" source="../code/sample/SampleApps/WebView2WpfBrowser/MainWindow.xaml.cs" id="OneTimeShareBuffer":::
|
:::code language="csharp" source="../code/sample/SampleApps/WebView2WpfBrowser/assets/sharedBuffer.html" id="ShareBufferScriptCode_1":::
|
:::code language="csharp" source="../code/sample/SampleApps/WebView2WpfBrowser/assets/sharedBuffer.html" id="ShareBufferScriptCode_2":::
|
</example>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Frame.FrameId">
|
<summary>
|
The unique identifier of the current frame. It's the same kind of ID as with the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.FrameId" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo.FrameId" />.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.ScreenCaptureStarting">
|
<summary>
|
ScreenCaptureStarting event is raised when the [Screen Capture API](https://www.w3.org/TR/screen-capture/) is requested by the user using getDisplayMedia().
|
</summary><remarks>
|
This relates to the <c>ScreenCaptureStarting</c> event on the <c>CoreWebView2</c>.
|
Both these events will be raised in the case of an iframe requesting screen capture. The <c>CoreWebView2Frame</c>'s event handlers will be invoked before the event handlers on the <c>CoreWebView2</c>. If the <c>Handled</c> property of the <c>ScreenCaptureStartingEventArgs</c> is set to TRUE within the <c>CoreWebView2Frame</c> event handler, then the event will not be raised on the <c>CoreWebView2</c>, and it's event handlers will not be invoked.
|
In the case of nested iframes, if the <c>ScreenCaptureStarting</c> event is handled in the current nested iframe (i.e., the Handled property of the <c>ScreenCaptureStartingEventArgs</c> is set to TRUE), the event will not be raised on the parent <c>CoreWebView2Frame</c>. However, if the <c>ScreenCaptureStarting</c> event is not handled in that nested iframe, the event will be raised from its nearest tracked parent <c>CoreWebView2Frame</c>.
|
It will iterate through the parent frame chain up to the main frame until a parent frame handles the request.
|
If a deferral is not taken on the event args, the subsequent scripts are blocked until the event handler returns. If a deferral is taken, the scripts are blocked until the deferral is completed.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.FrameCreated">
|
<summary>
|
FrameCreated is raised when a new direct descendant iframe is created. Handle this event to get access to <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Frame" /> objects.
|
</summary><remarks>
|
Use the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.Destroyed" /> to listen for when this iframe goes away.
|
</remarks><example>
|
:::code language="csharp" source="../code/sample/SampleApps/WebView2WpfBrowser/MainWindow.xaml.cs" id="FrameChildFrameCreated":::
|
</example>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Frame.AddHostObjectToScript(System.String,System.Object,System.Collections.Generic.IEnumerable{System.String})">
|
<summary>
|
Adds the provided host object to script running in the WebViewFrame with the specified name for the list of the specified origins.
|
The host object will be accessible for this iframe only if the iframe's origin during
|
access matches one of the origins which are passed. The provided origins
|
will be normalized before comparing to the origin of the document.
|
So the scheme name is made lower case, the host will be punycode decoded
|
as appropriate, default port values will be removed, and so on.
|
This means the origin's host may be punycode encoded or not and will match
|
regardless. If list contains malformed origin the call will fail.
|
The method can be called multiple times in a row without calling
|
RemoveHostObjectFromScript for the same object name. It will replace
|
the previous object with the new object and new list of origins.
|
List of origins will be treated as following:
|
1. empty list - call will succeed and object will be added for the iframe
|
but it will not be exposed to any origin;
|
2. list with origins - during access to host object from iframe the
|
origin will be checked that it belongs to this list;
|
3. list with "*" element - host object will be available for iframe for
|
all origins. We suggest not to use this feature without understanding
|
security implications of giving access to host object from from iframes
|
with unknown origins.
|
4. list with "file://" element - host object will be available for iframes
|
loaded via file protocol.
|
</summary>
|
<param name="name">
|
The name of the host object.
|
</param>
|
<param name="rawObject">
|
The host object to be added to script.
|
</param>
|
<param name="origins">
|
The list of the iframe origins for which host object will be accessible.
|
</param>
|
<seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddHostObjectToScript(System.String,System.Object)"/>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameCreatedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.FrameCreated" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2FrameCreatedEventArgs.Frame">
|
<summary>
|
Gets the created frame.
|
</summary><seealso cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Frame" />
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo">
|
<summary>
|
Provides a set of properties for a frame in the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2" />.</summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo.Name">
|
<summary>
|
Gets the name attribute of the frame, as in `<iframe name="frame-name">...</iframe>`.
|
</summary><remarks>
|
The returned string is empty when the frame has no name attribute.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo.Source">
|
<summary>
|
The URI of the document in the frame.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo.FrameId">
|
<summary>
|
The unique identifier of the frame associated with the current <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo" />. It's the same kind of ID as with the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.FrameId" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Frame.FrameId" />. FrameId will only be populated when obtained calling <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessExtendedInfo.AssociatedFrameInfos" />. <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo" /> objects obtained via <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ProcessFailed" /> will always have an invalid frame Id <c>0</c>.
|
</summary><remarks>
|
FrameId could be out of date as it's a snapshot. If there's <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2" /> created or destroyed or <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.FrameCreated" /> event or <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Frame.Destroyed" /> event after the asynchronous call <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.GetProcessExtendedInfosAsync" /> starts, you may want to call the asynchronous method again to get the updated `<see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo" />s.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo.FrameKind">
|
<summary>
|
Gets the kind of the frame. FrameKind will only be populated when obtained calling <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessExtendedInfo.AssociatedFrameInfos" />. <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo" />` objects obtained via <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ProcessFailed" /> will always have the default value <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2FrameKind.Unknown" />.
|
</summary><remarks>
|
FrameKind could be out of date as it's a snapshot.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo.ParentFrameInfo">
|
<summary>
|
This parent frame's <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo" />. ParentFrameInfo will only be populated when obtained via calling <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessExtendedInfo.AssociatedFrameInfos" />. <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo" /> objects obtained via <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ProcessFailed" /> will always have a <c>null</c> ParentFrameInfo. This property is also <c>null</c> for the top most document in the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2" /> which has no parent frame.
|
</summary><remarks>
|
ParentFrameInfo could be out of date as it's a snapshot.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpHeadersCollectionIterator">
|
<summary>
|
Iterator for a collection of HTTP headers.
|
</summary><seealso cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders" /><seealso cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders" />
|
<inheritdoc/>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2HttpHeadersCollectionIterator.HasCurrentHeader">
|
<summary><c>true</c> when the iterator has not run out of headers.
|
</summary><remarks>
|
If the collection over which the iterator is iterating is empty or if the iterator has gone past the end of the collection then this is <c>false</c>.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpHeadersCollectionIterator.MoveNext">
|
<inheritdoc/>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpHeadersCollectionIterator.Reset">
|
<summary>
|
No COM support; throws <see cref="T:System.NotSupportedException"/> instead.
|
</summary>
|
<exception cref="T:System.NotSupportedException">
|
No COM support.
|
</exception>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpHeadersCollectionIterator.Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2HttpHeadersCollectionIterator.Current">
|
<summary>
|
Gets the header in the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders"/>
|
or <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders"/> collection at the
|
current position of the enumerator.
|
</summary>
|
<exception cref="T:System.InvalidOperationException"></exception>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders">
|
<summary>
|
HTTP request headers.
|
</summary><remarks>
|
Used to inspect the HTTP request on <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event and <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /> event. It is possible to modify the HTTP request headers from a <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event, but not from a <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /> event.
|
</remarks><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" />
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders.GetHeader(System.String)">
|
<summary>Gets the header value matching the name.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders.GetHeaders(System.String)">
|
<summary>
|
Gets the header value matching the name using a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpHeadersCollectionIterator" />.
|
<returns>The header value matching the name.</returns></summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders.Contains(System.String)">
|
<summary>Checks whether the headers contain an entry that matches the header name.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders.SetHeader(System.String,System.String)">
|
<summary>Adds or updates header that matches the name.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders.RemoveHeader(System.String)">
|
<summary>Removes header that matches the name.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders.GetIterator">
|
<summary>
|
Gets a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpHeadersCollectionIterator" /> over the collection of request headers.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders.System#Collections#IEnumerable#GetEnumerator">
|
<inheritdoc/>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders.System#Collections#Generic#IEnumerable{System#Collections#Generic#KeyValuePair{System#String,System#String}}#GetEnumerator">
|
<inheritdoc/>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders.GetEnumerator">
|
<summary>
|
Returns an enumerator that iterates through the <see
|
cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders"/> or <see
|
cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders"/> collection.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders">
|
<summary>
|
HTTP response headers.
|
</summary><remarks>
|
Used to construct a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponse" /> for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders.AppendHeader(System.String,System.String)">
|
<summary>Appends header line with name and value.
|
</summary><param name="name">The header name to be appended.</param><param name="value">The header value to be appended.</param>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders.Contains(System.String)">
|
<summary>
|
Checks whether this CoreWebView2HttpResponseHeaders contain entries matching the header name.
|
</summary><param name="name">The name of the header to seek.</param>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders.GetHeader(System.String)">
|
<summary>Gets the first header value in the collection matching the name.
|
</summary><param name="name">The header name.</param><returns>The first header value in the collection matching the name.</returns>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders.GetHeaders(System.String)">
|
<summary>Gets the header values matching the name.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders.GetIterator">
|
<summary>
|
Gets a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpHeadersCollectionIterator" /> over the collection of entire <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders" />.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders.System#Collections#IEnumerable#GetEnumerator">
|
<inheritdoc/>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders.System#Collections#Generic#IEnumerable{System#Collections#Generic#KeyValuePair{System#String,System#String}}#GetEnumerator">
|
<inheritdoc/>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders.GetEnumerator">
|
<summary>
|
Returns an enumerator that iterates through the <see
|
cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpRequestHeaders"/> or <see
|
cref="T:Microsoft.Web.WebView2.Core.CoreWebView2HttpResponseHeaders"/> collection.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2LaunchingExternalUriSchemeEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.LaunchingExternalUriScheme" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2LaunchingExternalUriSchemeEventArgs.Cancel">
|
<summary>
|
Determines whether to cancel the navigation.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2LaunchingExternalUriSchemeEventArgs.InitiatingOrigin">
|
<summary>
|
Gets the origin initiating the external URI scheme launch.
|
</summary><remarks>
|
The origin will be an empty string if the request is initiated by calling <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.Navigate(System.String)" /> on the external URI scheme. If a script initiates the navigation, the `InitiatingOrigin` will be the top-level document's `Source`, i.e. if `window.location` is set to `"calculator://", the `InitiatingOrigin` will be set to `calculator://`. If the request is initiated from a child frame, the `InitiatingOrigin` will be the source of that child frame. If the `InitiatingOrigin` is [opaque](https://html.spec.whatwg.org/multipage/origin.html#concept-origin-opaque), the `InitiatingOrigin` reported in the event args will be its precursor origin. The precursor origin is the origin that created the opaque origin. For example, if a frame on example.com opens a subframe with a different opaque origin, the subframe's precursor origin is example.com.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2LaunchingExternalUriSchemeEventArgs.IsUserInitiated">
|
<summary><c>true</c> when the launching external URI scheme request was initiated through a user gesture.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2LaunchingExternalUriSchemeEventArgs.Uri">
|
<summary>
|
Gets the URI with the external URI scheme to be launched.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2LaunchingExternalUriSchemeEventArgs.GetDeferral">
|
<summary>
|
Gets a Deferral object and puts the event into a deferred state.
|
Use this to Complete the launching external URI scheme request at a later time.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusRequestedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.MoveFocusRequested" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusRequestedEventArgs.Handled">
|
<summary>
|
Indicates whether the event has been handled by the app.
|
</summary><remarks>
|
If the app has moved the focus to another desired location, it should set Handled property to <c>true</c>. When <c>Handled</c> property is <c>false</c> after the event handler returns, default action is taken. The default action is to try to find the next tab stop child window in the app and try to move focus to that window. If no other window exists to move focus, focus is cycled within the web content of the WebView.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2MoveFocusRequestedEventArgs.Reason">
|
<summary>
|
Gets the reason for WebView to raise the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.MoveFocusRequested" /> event.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationCompleted" /> event.</summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs.IsSuccess">
|
<summary><c>true</c> when the navigation is successful; <c>false</c> for a navigation that ended up in an error page (failures due to no network, DNS lookup failure, HTTP server responds with 4xx). Note that WebView2 will report the navigation as 'unsuccessful' if the load for the navigation did not reach the expected completion for any reason. Such reasons include potentially catastrophic issues such network and certificate issues, but can also be the result of intended actions such as the app canceling a navigation or navigating away before the original navigation completed. Applications should not just rely on this flag, but also consider the reported WebErrorStatus to determine whether the failure is indeed catastrophic in their context.</summary><remarks>
|
WebErrorStatuses that may indicate a non-catastrophic failure include:
|
|
<list type="bullet"><item><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.OperationCanceled" /></description></item><item><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.ValidAuthenticationCredentialsRequired" /></description></item><item><description><see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.ValidProxyAuthenticationRequired" /></description></item></list>
|
|
This may also be <c>false</c> for additional scenarios such as <c>window.stop()</c> run on navigated page.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs.NavigationId">
|
<summary>
|
Gets the ID of the navigation.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs.WebErrorStatus">
|
<summary>
|
Gets the error code if the navigation failed.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs.HttpStatusCode">
|
<summary>
|
The HTTP status code of the navigation if it involved an HTTP request. For instance, this will usually be 200 if the request was successful, 404 if a page was not found, etc. See https://developer.mozilla.org/docs/Web/HTTP/Status for a list of common status codes.
|
</summary><remarks>
|
The <c>HttpStatusCode</c> property will be 0 in the following cases:
|
<list type="bullet"><item><description>
|
The navigation did not involve an HTTP request. For instance, if it was a navigation to a <c>file://</c> URL, or if it was a same-document navigation.
|
</description></item><item><description>
|
The navigation failed before a response was received. For instance, if the hostname was not found, or if there was a network error.
|
</description></item></list>
|
In those cases, you can get more information from the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs.IsSuccess" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs.WebErrorStatus" /> properties.
|
|
If the navigation receives a successful HTTP response, but the navigated page calls <c>window.stop()</c> before it finishes loading, then HttpStatusCode may contain a success code like 200, but <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs.IsSuccess" /> will be <c>false</c> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationCompletedEventArgs.WebErrorStatus" /> will be <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2WebErrorStatus.ConnectionAborted" />.
|
|
Since WebView2 handles HTTP continuations and redirects automatically, it is unlikely for HttpStatusCode to ever be in the 1xx or 3xx ranges.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /> event.</summary>
|
<summary></summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs.Cancel">
|
<summary>
|
Determines whether to cancel the navigation.
|
</summary><remarks>
|
If set to <c>true</c>, the navigation is no longer present and the content of the current page is intact. For performance reasons, <c>GET</c> HTTP requests may happen, while the host is responding. You may set cookies and use part of a request for the navigation. Navigations to about schemes are cancellable, unless `msWebView2CancellableAboutNavigations` feature flag is disabled. Cancellation of frame navigation to `srcdoc` is not supported and will be ignored.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs.IsRedirected">
|
<summary><c>true</c> when the navigation is redirected.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs.IsUserInitiated">
|
<summary><c>true</c> when the new window request was initiated through a user gesture.
|
</summary><remarks>
|
Examples of user initiated requests are:
|
<list type="bullet"><item><description>Selecting an anchor tag with target</description></item><item><description>Programmatic window open from a script that directly run as a result of user interaction such as via onclick handlers.</description></item></list>
|
Non-user initiated requests are programmatic window opens from a script that are not directly triggered by user interaction, such as those that run while loading a new page or via timers.
|
The Microsoft Edge popup blocker is disabled for WebView so the app is able to use this flag to block non-user initiated popups.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs.NavigationId">
|
<summary>
|
Gets the ID of the navigation.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs.RequestHeaders">
|
<summary>
|
Gets the HTTP request headers for the navigation.
|
</summary><remarks>
|
Note, you are not able to modify the HTTP request headers in a <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /> event.
|
</remarks><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs.Uri">
|
<summary>
|
Gets the uri of the requested navigation.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs.AdditionalAllowedFrameAncestors">
|
<summary>Additional allowed frame ancestors set by the host app.
|
</summary><remarks>
|
The app may set this property to allow a frame to be embedded by additional ancestors besides what is allowed by http header [X-Frame-Options](https://developer.mozilla.org/docs/Web/HTTP/Headers/X-Frame-Options) and [Content-Security-Policy frame-ancestors directive](https://developer.mozilla.org/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors).
|
If set, a frame ancestor is allowed if it is allowed by the additional allowed frame ancestors or original http header from the site.
|
Whether an ancestor is allowed by the additional allowed frame ancestors is done the same way as if the site provided it as the source list of the Content-Security-Policy frame-ancestors directive.
|
For example, if <c>https://example.com</c> and <c>https://www.example.com</c> are the origins of the top page and intermediate iframes that embed a nested site-embedding iframe, and you fully trust those origins, you should set this property to <c>https://example.com https://www.example.com</c>.
|
|
This property gives the app the ability to use iframe to embed sites that otherwise could not be embedded in an iframe in trusted app pages.
|
This could potentially subject the embedded sites to [Clickjacking](https://wikipedia.org/wiki/Clickjacking) attack from the code running in the embedding web page. Therefore, you should only set this property with origins of fully trusted embedding page and any intermediate iframes.
|
Whenever possible, you should use the list of specific origins of the top and intermediate frames instead of wildcard characters for this property.
|
This API is to provide limited support for app scenarios that used to be supported by <c><webview></c> element in other solutions like JavaScript UWP apps and Electron.
|
You should limit the usage of this property to trusted pages, and specific navigation target url, by checking the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2.Source" />, and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs.Uri" />.
|
|
This property is ignored for top level document navigation.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NavigationStartingEventArgs.NavigationKind">
|
<summary>
|
Gets the navigation kind of the navigation.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NewWindowRequested" /> event.</summary>
|
<summary></summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.Handled">
|
<summary>
|
Indicates whether the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NewWindowRequested" /> event is handled by host.
|
</summary><remarks>
|
If this is <c>false</c> and no <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.NewWindow" /> is set, the WebView opens a popup window and returns the opened <c>WindowProxy</c> to the opener script. Note that in this case, there is no avenue to control the popup window from the app. If set to <c>true</c> and no <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.NewWindow" /> is set for <c>window.open()</c>, the opened <c>proxy</c> is for a dummy window object, but this window does not load and is immediately closed. The default value is <c>false</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.IsUserInitiated">
|
<summary><c>true</c> when the new window request was initiated through a user gesture such as selecting an anchor tag with target.
|
</summary><remarks>
|
The Microsoft Edge popup blocker is disabled for WebView so the app is able to use this flag to block non-user initiated popups.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.NewWindow">
|
<summary>
|
Gets the new window or sets a WebView as a result of the new window requested.
|
</summary><remarks>
|
Provides a WebView as the target for a <c>window.open()</c> from inside the requesting WebView. If this is set, the top-level window of this WebView is returned as the opened [WindowProxy](https://developer.mozilla.org/docs/glossary/windowproxy) to the opener script. If this is not set, then <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.Handled" /> is checked to determine behavior for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NewWindowRequested" />.
|
The methods which should affect the new web contents like <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.AddScriptToExecuteOnDocumentCreatedAsync(System.String)" /> has to be called and completed before setting NewWindow. Other methods which should affect the new web contents like <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> have to be called after setting NewWindow. It is best not to use <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.RemoveScriptToExecuteOnDocumentCreated(System.String)" /> before setting NewWindow, otherwise it may not work for later added scripts.
|
WebView provided in the <c>NewWindow</c> property must be on the same <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment" /> as the opener WebView and cannot be navigated. Changes to settings should be made before setting NewWindow to ensure that those settings take effect for the newly setup WebView. The new WebView must have the same profile as the opener WebView.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.Uri">
|
<summary>
|
Gets the target uri of the new window request.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.WindowFeatures">
|
<summary>
|
Gets the window features specified by the <c>window.open()</c> call.
|
These features should be considered for positioning and sizing of new WebView windows.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.GetDeferral">
|
<summary>
|
Gets a Deferral object and put the event into a deferred state.
|
Use this to Complete the window open request at a later time. While this event is deferred the opener window returns a WindowProxy to an un-navigated window, which navigates when the deferral is complete.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.Name">
|
<summary>
|
Gets the name of the new window.
|
</summary><remarks>
|
This window can be created via <c>window.open(url, windowName)</c>, where the windowName parameter corresponds to <c>Name</c> property.
|
If no windowName is passed to `window.open`, then the `Name` property will be set to an empty string. Additionally, if window is opened through other means, such as `<a target="windowName" />` or `<iframe name="windowName" />`, then the `Name` property will be set accordingly. In the case of target=_blank, the `Name` property will be an empty string.
|
Opening a window via Ctrl+clicking a link would result in the <c>Name</c> property being set to an empty string.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NewWindowRequestedEventArgs.OriginalSourceFrameInfo">
|
<summary>The frame info of the frame where the new window request originated. The
|
`OriginalSourceFrameInfo` is a snapshot of frame information at the time when the
|
new window was requested.
|
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo" /> for details on frame properties.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionChangedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2CompositionController.NonClientRegionChanged" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionChangedEventArgs.RegionKind">
|
<summary>
|
Gets the region kind <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2NonClientRegionKind" /> corresponding to the event.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2Notification">
|
<summary>
|
An object that represents a [HTML Notification object](https://developer.mozilla.org/docs/Web/API/Notification).</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.BadgeUri">
|
<summary>
|
A string containing the URI of the image used to represent the notification when there isn't enough space to display the notification itself.
|
</summary><remarks>
|
The default value is an empty string.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.Body">
|
<summary>
|
A string representing the body text of the notification.
|
</summary><remarks>
|
The default value is an empty string.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.BodyImageUri">
|
<summary>
|
A string containing the URI of an image to be displayed in the notification.
|
</summary><remarks>
|
The default value is an empty string.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.Direction">
|
<summary>
|
The text direction in which to display the notification.</summary><remarks>
|
This corresponds to [Notification.dir](https://developer.mozilla.org/docs/Web/API/Notification/dir) DOM API. The default value is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2TextDirectionKind.Default" />.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.IconUri">
|
<summary>
|
A string containing the URI of an icon to be displayed in the notification.
|
</summary><remarks>
|
The default value is an empty string.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.IsSilent">
|
<summary>
|
Indicates whether the notification should be silent -- i.e., no sounds or vibrations should be issued, regardless of the device settings.
|
</summary><remarks>
|
This corresponds to [Notification.silent](https://developer.mozilla.org/docs/Web/API/Notification/silent) DOM API. The default value is <c>false</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.Language">
|
<summary>
|
The notification's language, as intended to be specified using a string representing a language tag (such as <c>en-US</c>) according to [BCP47](https://datatracker.ietf.org/doc/html/rfc5646).
|
</summary><remarks>
|
Note that no validation is performed on this property and it can be any string the notification sender specifies. This corresponds to [Notification.lang](https://developer.mozilla.org/docs/Web/API/Notification/lang) DOM API. The default value is an empty string.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.RequiresInteraction">
|
<summary>
|
A boolean value indicating that a notification should remain active until the user clicks or dismisses it, rather than closing automatically.
|
</summary><remarks>
|
This corresponds to [Notification.requireInteraction](https://developer.mozilla.org/docs/Web/API/Notification/requireInteraction) DOM API. Note that you may not be able to necessarily implement this due to native API limitations. The default value is <c>false</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.ShouldRenotify">
|
<summary>
|
Indicates whether the user should be notified after a new notification replaces an old one.
|
</summary><remarks>
|
This corresponds to [Notification.renotify](https://developer.mozilla.org/docs/Web/API/Notification/renotify) DOM API. The default value is <c>false</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.Tag">
|
<summary>
|
A string representing an identifying tag for the notification.
|
</summary><remarks>
|
This corresponds to [Notification.tag](https://developer.mozilla.org/docs/Web/API/Notification/tag) DOM API. The default value is an empty string.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.Title">
|
<summary>
|
The title of the notification.</summary>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Notification.CloseRequested">
|
<summary>
|
This event is raised when the notification is closed by the web code, such as through <c>notification.close()</c>.
|
</summary><remarks>
|
You don't need to call <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Notification.ReportClosed" /> since this is coming from the web code.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Notification.ReportShown">
|
<summary>
|
The host may run this to report the notification has been displayed and it will cause the [show](https://developer.mozilla.org/docs/Web/API/Notification/show_event) event to be raised for non-persistent notifications.
|
</summary><remarks>
|
You must not run this unless you are handling the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NotificationReceived" />. API throws COMException with error code of <c>HRESULT_FROM_WIN32(ERROR_INVALID_STATE)</c> if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NotificationReceivedEventArgs.Handled" /> is <c>false</c> when this is called.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Notification.ReportClicked">
|
<summary>
|
The host may run this to report the notification has been clicked, and it will cause the [click](https://developer.mozilla.org/docs/Web/API/Notification/click_event) event to be raised for non-persistent notifications.
|
You must not run this unless you are handling the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NotificationReceived" />. API throws COMException with error code of <c>HRESULT_FROM_WIN32(ERROR_INVALID_STATE)</c> if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NotificationReceivedEventArgs.Handled" /> is <c>false</c> or <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Notification.ReportShown" /> has not been run when this is called.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Notification.ReportClosed">
|
<summary>
|
The host may run this to report the notification was dismissed, and it will cause the [close](https://developer.mozilla.org/docs/Web/API/Notification/close_event) event to be raised for non-persistent notifications.
|
</summary><remarks>
|
You must not run this unless you are handling the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NotificationReceived" />. API throws COMException with error code of <c>HRESULT_FROM_WIN32(ERROR_INVALID_STATE)</c> if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NotificationReceivedEventArgs.Handled" /> is <c>false</c> or <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Notification.ReportShown" /> has not been run when this is called.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.Timestamp">
|
<summary>
|
Specifies the time at which a notification is created or applicable
|
(past, present, or future).
|
</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Notification.VibrationPattern">
|
<summary>
|
Gets the vibration pattern for devices with vibration hardware to emit.
|
</summary>
|
<remarks>
|
The vibration pattern can be represented by an array of 64-bit
|
unsigned integers describing a pattern of vibrations and pauses. See
|
[Vibration API](https://developer.mozilla.org/docs/Web/API/Vibration_API) for
|
more information. This corresponds to
|
[Notification.vibrate](https://developer.mozilla.org/docs/Web/API/Notification/vibrate)
|
DOM API. An empty list is returned if no vibration patterns are
|
specified.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2NotificationReceivedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NotificationReceived" />.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NotificationReceivedEventArgs.Handled">
|
<summary>
|
Sets whether the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NotificationReceived" /> is handled by the host after the event handler completes or if there is a deferral then after the deferral is completed.
|
</summary><remarks>
|
If <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NotificationReceivedEventArgs.Handled" /> is set to <c>true</c> then WebView will not display the notification with the default UI, and the host will be responsible for handling the notification and for letting the web content know that the notification has been displayed, clicked, or closed. You must set <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NotificationReceivedEventArgs.Handled" /> to <c>true</c> before you call <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Notification.ReportShown" />, <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Notification.ReportClicked" /> and <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Notification.ReportClosed" />, otherwise they will fail with <c>HRESULT_FROM_WIN32(ERROR_INVALID_STATE)</c>. If after the event handler or deferral completes <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NotificationReceivedEventArgs.Handled" /> is set to <c>false</c> then WebView will display the default notification UI. Note that you cannot un-handle this event once you have set <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2NotificationReceivedEventArgs.Handled" /> to be <c>true</c>. The initial value is <c>false</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NotificationReceivedEventArgs.Notification">
|
<summary>
|
The notification that was received.
|
</summary><remarks>
|
You can access the properties on the Notification object to show your own notification.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2NotificationReceivedEventArgs.SenderOrigin">
|
<summary>
|
The origin of the web content that sends the notification, such as <c>https://example.com/</c> or <c>https://www.example.com/</c>.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2NotificationReceivedEventArgs.GetDeferral">
|
<summary>
|
Gets a Deferral object.
|
Use this to Complete the event at a later time.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PermissionRequestedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.PermissionRequested" /> event.</summary>
|
<summary></summary>
|
<summary>This is a continuation of the `ICoreWebView2PermissionRequestedEventArgs2` interface.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PermissionRequestedEventArgs.IsUserInitiated">
|
<summary><c>true</c> when the permission request was initiated through a user gesture such as clicking an anchor tag with target.
|
</summary><remarks>
|
Being initiated through a user gesture does not mean that user intended to access the associated resource.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PermissionRequestedEventArgs.PermissionKind">
|
<summary>
|
Gets the kind of the permission that is requested.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PermissionRequestedEventArgs.State">
|
<summary>
|
Gets or sets the status of a permission request. For example, whether the request is granted.</summary><remarks>
|
The default value is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2PermissionState.Default" />.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PermissionRequestedEventArgs.Uri">
|
<summary>
|
Gets the origin of the web content that requests the permission.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2PermissionRequestedEventArgs.GetDeferral">
|
<summary>
|
Gets a Deferral object.
|
</summary><remarks>
|
Use the deferral object to make the permission decision at a later time. The deferral only applies to the current request, and does not prevent the <c>PermissionRequested</c> event from getting raised for new requests. However, for some permission kinds the WebView will avoid creating a new request if there is a pending request of the same kind.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PermissionRequestedEventArgs.Handled">
|
<summary>
|
The host may set this flag to <c>TRUE</c> to prevent the <c>PermissionRequested</c> event from firing on the <c>CoreWebView2</c> as well.
|
By default, both the <c>PermissionRequested</c> on the <c>CoreWebView2Frame</c> and <c>CoreWebView2</c> will be fired.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PermissionRequestedEventArgs.SavesInProfile">
|
<summary>
|
Set the <c>SavesInProfile</c> property to <c>FALSE</c> to not persist the state beyond the current request, and to continue to receive <c>PermissionRequested</c> events for this origin and permission kind.
|
</summary><remarks>
|
The permission state set from the <c>PermissionRequested</c> event is saved in the profile by default; it is persisted across sessions and becomes the new default behavior for future <c>PermissionRequested</c> events. Browser heuristics can affect whether the event continues to be raised when the state is persisted.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PermissionSetting">
|
<summary>
|
Provides a set of properties for a permission setting.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PermissionSetting.PermissionKind">
|
<summary>
|
The kind of the permission setting.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PermissionSetting.PermissionOrigin">
|
<summary>
|
The origin of the permission setting.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PermissionSetting.PermissionState">
|
<summary>
|
The state of the permission setting.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo">
|
<summary>
|
This mostly represents a combined win32 <c>POINTER_INFO</c>, <c>POINTER_TOUCH_INFO</c>, and <c>POINTER_PEN_INFO</c> object.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.ButtonChangeKind">
|
<summary>
|
Gets or sets the ButtonChangeKind of the pointer event.
|
</summary><remarks>
|
This corresponds to the ButtonChangeKind property of the <c>POINTER_INFO</c> struct. The values are defined by the <c>POINTER_BUTTON_CHANGE_KIND</c> enum in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.DisplayRect">
|
<summary>
|
Gets or sets the DisplayRect of the sourceDevice property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.FrameId">
|
<summary>
|
Gets or sets the FrameID of the pointer event.
|
</summary><remarks>
|
This corresponds to the frameId property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.HimetricLocation">
|
<summary>
|
Gets or sets the HimetricLocation of the pointer event.
|
</summary><remarks>
|
This corresponds to the ptHimetricLocation property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.HimetricLocationRaw">
|
<summary>
|
Gets or sets the HimetricLocationRaw of the pointer event.
|
</summary><remarks>
|
This corresponds to the ptHimetricLocationRaw property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.HistoryCount">
|
<summary>
|
Gets or sets the HistoryCount of the pointer event.
|
</summary><remarks>
|
This corresponds to the historyCount property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.InputData">
|
<summary>
|
Gets or sets the InputData of the pointer event.
|
</summary><remarks>
|
This corresponds to the InputData property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.KeyStates">
|
<summary>
|
Gets or sets the KeyStates of the pointer event.
|
</summary><remarks>
|
This corresponds to the dwKeyStates property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PenFlags">
|
<summary>
|
Gets or sets the PenFlags of the pointer event.
|
</summary><remarks>
|
This corresponds to the penFlags property of the <c>POINTER_PEN_INFO</c> struct. The values are defined by the PEN_FLAGS constants in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PenMask">
|
<summary>
|
Gets or sets the PenMask of the pointer event.
|
</summary><remarks>
|
This corresponds to the penMask property of the <c>POINTER_PEN_INFO</c> struct. The values are defined by the PEN_MASK constants in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PenPressure">
|
<summary>
|
Gets or sets the PenPressure of the pointer event.
|
</summary><remarks>
|
This corresponds to the pressure property of the <c>POINTER_PEN_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PenRotation">
|
<summary>
|
Gets or sets the PenRotation of the pointer event.
|
</summary><remarks>
|
This corresponds to the rotation property of the <c>POINTER_PEN_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PenTiltX">
|
<summary>
|
Gets or sets the PenTiltX of the pointer event.
|
</summary><remarks>
|
This corresponds to the tiltX property of the <c>POINTER_PEN_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PenTiltY">
|
<summary>
|
Gets or sets the PenTiltY of the pointer event.
|
</summary><remarks>
|
This corresponds to the tiltY property of the <c>POINTER_PEN_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PerformanceCount">
|
<summary>
|
Gets or sets the PerformanceCount of the pointer event.
|
</summary><remarks>
|
This corresponds to the PerformanceCount property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PixelLocation">
|
<summary>
|
Gets or sets the PixelLocation of the pointer event.
|
</summary><remarks>
|
This corresponds to the ptPixelLocation property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PixelLocationRaw">
|
<summary>
|
Gets or sets the PixelLocationRaw of the pointer event.
|
</summary><remarks>
|
This corresponds to the ptPixelLocationRaw property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PointerDeviceRect">
|
<summary>
|
Gets or sets the PointerDeviceRect of the sourceDevice property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PointerFlags">
|
<summary>
|
Gets or sets the PointerFlags of the pointer event.
|
</summary><remarks>
|
This corresponds to the pointerFlags property of the <c>POINTER_INFO</c> struct. The values are defined by the <c>POINTER_FLAGS</c> constants in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PointerId">
|
<summary>
|
Gets or sets the PointerId of the pointer event.
|
</summary><remarks>
|
This corresponds to the pointerId property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.PointerKind">
|
<summary>
|
Gets or sets the PointerKind of the pointer event.
|
</summary><remarks>
|
This corresponds to the pointerKind property of the <c>POINTER_INFO</c> struct. The values are defined by the <c>POINTER_INPUT_KIND</c> enum in the Windows SDK (_winuser.h_). Supports PT_PEN and PT_TOUCH.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.Time">
|
<summary>
|
Gets or sets the Time of the pointer event.
|
</summary><remarks>
|
This corresponds to the dwTime property of the <c>POINTER_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.TouchContact">
|
<summary>
|
Gets or sets the TouchContact of the pointer event.
|
</summary><remarks>
|
This corresponds to the rcContact property of the <c>POINTER_TOUCH_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.TouchContactRaw">
|
<summary>
|
Gets or sets the TouchContactRaw of the pointer event.
|
</summary><remarks>
|
This corresponds to the rcContactRaw property of the <c>POINTER_TOUCH_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.TouchFlags">
|
<summary>
|
Gets or sets the TouchFlags of the pointer event.
|
</summary><remarks>
|
This corresponds to the touchFlags property of the <c>POINTER_TOUCH_INFO</c> struct. The values are defined by the TOUCH_FLAGS constants in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.TouchMask">
|
<summary>
|
Gets or sets the TouchMask of the pointer event.
|
</summary><remarks>
|
This corresponds to the touchMask property of the <c>POINTER_TOUCH_INFO</c> struct. The values are defined by the TOUCH_MASK constants in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.TouchOrientation">
|
<summary>
|
Gets or sets the TouchOrientation of the pointer event.
|
</summary><remarks>
|
This corresponds to the orientation property of the <c>POINTER_TOUCH_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PointerInfo.TouchPressure">
|
<summary>
|
Gets or sets the TouchPressure of the pointer event.
|
</summary><remarks>
|
This corresponds to the pressure property of the <c>POINTER_TOUCH_INFO</c> struct as defined in the Windows SDK (_winuser.h_).
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings">
|
<summary>
|
Settings used by the <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfAsync(System.String,Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> method.</summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.FooterUri">
|
<summary>
|
The URI in the footer if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.ShouldPrintHeaderAndFooter" /> is <c>true</c>.
|
</summary><remarks>
|
The default value is the current URI. If an empty string or null value is provided, no URI is shown in the footer.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.HeaderTitle">
|
<summary>
|
The title in the header if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.ShouldPrintHeaderAndFooter" /> is <c>true</c>.
|
</summary><remarks>
|
The default value is the title of the current document. If an empty string or null value is provided, no title is shown in the header.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.MarginBottom">
|
<summary>
|
The bottom margin in inches.
|
</summary><remarks>
|
The default is 1 cm, or ~0.4 inches. A margin cannot be less than zero. If an invalid value is provided, the current value is not changed and an ArgumentException is thrown.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.MarginLeft">
|
<summary>
|
The left margin in inches.
|
</summary><remarks>
|
The default is 1 cm, or ~0.4 inches. A margin cannot be less than zero. If an invalid value is provided, the current value is not changed and an ArgumentException is thrown.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.MarginRight">
|
<summary>
|
The right margin in inches.
|
</summary><remarks>
|
The default is 1 cm, or ~0.4 inches. A margin cannot be less than zero. If an invalid value is provided, the current value is not changed and an ArgumentException is thrown.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.MarginTop">
|
<summary>
|
The top margin in inches.
|
</summary><remarks>
|
The default is 1 cm, or ~0.4 inches. A margin cannot be less than zero. If an invalid value is provided, the current value is not changed and an ArgumentException is thrown.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.Orientation">
|
<summary>
|
The orientation can be portrait or landscape.
|
</summary><remarks>
|
The default orientation is portrait. See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintOrientation" />.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.PageHeight">
|
<summary>
|
The page height in inches.
|
</summary><remarks>
|
The default height is 11 inches. If the provided page height is less than or equal to zero, the current value is not changed and an ArgumentException is thrown.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.PageWidth">
|
<summary>
|
The page width in inches.
|
</summary><remarks>
|
The default width is 8.5 inches. If the provided page width is less than or equal to zero, the current value is not changed and an ArgumentException is thrown.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.ScaleFactor">
|
<summary>
|
The scale factor is a value between 0.1 and 2.0.
|
</summary><remarks>
|
The default is 1.0. If an invalid value is provided, the current value is not changed and an ArgumentException is thrown.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.ShouldPrintBackgrounds">
|
<summary><c>true</c> if background colors and images should be printed.
|
</summary><remarks>
|
The default value is <c>false</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.ShouldPrintHeaderAndFooter">
|
<summary><c>true</c> if header and footer should be printed.
|
</summary><remarks>
|
The default value is <c>false</c>. The header consists of the date and time of printing, and the title of the page. The footer consists of the URI and page number. The height of the header and footer is 0.5 cm, or ~0.2 inches.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.ShouldPrintSelectionOnly">
|
<summary><c>true</c> if only the current end user's selection of HTML in the document should be printed.
|
</summary><remarks>
|
The default value is <c>false</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.Collation">
|
<summary>
|
Printer collation.
|
</summary><remarks>
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintCollation" /> for descriptions of collation. The default value is <c>CoreWebView2PrintCollation.Default</c>.
|
|
Printing uses default value of printer's collation if an invalid value is provided for the specific printer.
|
|
This value is ignored in <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfStreamAsync(Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> method.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.ColorMode">
|
<summary>
|
Printer color mode.
|
</summary><remarks>
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintColorMode" /> for descriptions of color modes. The default value is <c>CoreWebView2PrintColorMode.Default</c>.
|
|
Printing uses default value of printer supported color if an invalid value is provided for the specific printer.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.Copies">
|
<summary>
|
Number of copies to print. Minimum value is <c>1</c> and the maximum copies count is <c>999</c>.
|
</summary><remarks>
|
The default value is 1.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.Duplex">
|
<summary>
|
Printer duplex settings.
|
</summary><remarks>
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintDuplex" /> for descriptions of duplex. The default value is <c>CoreWebView2PrintDuplex.Default</c>.
|
|
Printing uses default value of printer's duplex if an invalid value is provided for the specific printer.
|
|
This value is ignored in <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfStreamAsync(Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> method.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.MediaSize">
|
<summary>
|
Printer media size.
|
</summary><remarks>
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2PrintMediaSize" /> for descriptions of media size. The default value is <c>CoreWebView2PrintMediaSize.Default</c>.
|
|
If media size is <c>CoreWebView2PrintMediaSize.Custom</c>, you should set the PageWidth and PageHeight.
|
|
Printing uses default value of printer supported media size if an invalid value is provided for the specific printer.
|
|
This value is ignored in <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfStreamAsync(Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> method.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.PageRanges">
|
<summary>
|
Page range to print. Defaults to empty string, which means print all pages.</summary><remarks>
|
The PageRanges property is a list of page ranges specifying one or more pages that should be printed separated by commas. Any whitespace between page ranges is ignored.
|
A valid page range is either a single integer identifying the page to print, or a range in the form <c>[start page]-[last page]</c> where <c>start page</c> and <c>last page</c> are integers identifying the first and last inclusive pages respectively to print.
|
Every page identifier is an integer greater than 0 unless wildcards are used (see below examples).
|
The first page is 1.
|
|
In a page range of the form <c>[start page]-[last page]</c> the start page number must be larger than 0 and less than or equal to the document's total page count.
|
If the <c>start page</c> is not present, then 1 is used as the <c>start page</c>.
|
The <c>last page</c> must be larger than the <c>start page</c>.
|
If the <c>last page</c> is not present, then the document total page count is used as the <c>last page</c>.
|
|
Repeating a page does not print it multiple times. To print multiple times, use the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.Copies" /> property.
|
|
The pages are always printed in ascending order, even if specified in non-ascending order.
|
|
If page range is not valid or if a page is greater than document total page count, ArgumentException is thrown.
|
|
The following examples assume a document with 20 total pages.
|
|
<list type="table"><listheader><description>Example</description><description>Result</description><description>Notes</description></listheader><item><description>"2"</description><description>Page 2</description><description></description></item><item><description>"1-4, 9, 3-6, 10, 11"</description><description>Pages 1-6, 9-11</description><description></description></item><item><description>"1-4, -6" </description><description>Pages 1-6</description><description>The "-6" is interpreted as "1-6".</description></item><item><description>"2-" </description><description>Pages 2-20</description><description>The "2-" is interpreted as "pages 2 to the end of the document".</description></item><item><description>"4-2, 11, -6"</description><description>Invalid</description><description>"4-2" is an invalid range. </description></item><item><description>"-"</description><description>Pages 1-20</description><description>The "-" is interpreted as "page 1 to the end of the document".</description></item><item><description>"1-4dsf, 11"</description><description>Invalid</description><description></description></item><item><description>"2-2"</description><description>Page 2</description><description></description></item></list></remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.PagesPerSide">
|
<summary>
|
Prints multiple pages of a document on a single piece of paper. Choose from 1, 2, 4, 6, 9 or 16.</summary><remarks>
|
The default value is 1.
|
|
If an invalid value is provided, ArgumentException is thrown.
|
|
Below examples shows print output for PagesPerSide and Duplex.
|
|
<list type="table"><listheader><description>PagesPerSide</description><description>Total pages</description><description>Two-sided printing</description><description>Result</description></listheader><item><description>1</description><description>1</description><description>-</description><description>1 page on the front side.</description></item><item><description>2</description><description>1</description><description>Yes</description><description>1 page on the front side.</description></item><item><description>2</description><description>4</description><description>-</description><description>2 pages on the first paper and 2 pages on the next paper.</description></item><item><description>2</description><description>4</description><description>Yes</description><description>2 pages on the front side and 2 pages on back side.</description></item><item><description>4</description><description>4</description><description>Yes</description><description>4 pages on the front side.</description></item><item><description>4</description><description>8</description><description>Yes</description><description>4 pages on the front side and 4 pages on the back side.</description></item></list></remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings.PrinterName">
|
<summary>
|
The name of the printer to use.
|
</summary><remarks>
|
Defaults to empty string. If the printer name is empty string or null, then it prints to the default printer on the user OS.
|
|
If provided printer name doesn't match with the name of any installed printers on the user OS, the method returns with <c>CoreWebView2PrintStatus.PrinterUnavailable</c>.
|
|
Use [DeviceInformation.FindAllAsync](/uwp/api/windows.devices.enumeration.deviceinformation.findallasync) to get the list of local printers with AQS as "System.Devices.HardwareIds:~~"PRINTENUM\LocalPrintQueue""
|
|
This value is ignored in <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PrintToPdfStreamAsync(Microsoft.Web.WebView2.Core.CoreWebView2PrintSettings)" /> method.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessExtendedInfo">
|
<summary>Provides a set of properties for a process list with extended information in the .</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessExtendedInfo.AssociatedFrameInfos">
|
<summary>
|
Provides the collection of associated <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo" />s which are actively running (showing or hiding UI elements) in this renderer process.
|
</summary><remarks>
|
AssociatedFrameInfos will only be populated when this <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessExtendedInfo" /> corresponds to a renderer process. Non-renderer processes will always have an empty AssociatedFrameInfo. AssociatedFrameInfos may also be empty for renderer processes that have no active frames.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessExtendedInfo.ProcessInfo">
|
<summary>
|
Provides the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessInfo" /> of the current process.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ProcessFailed" /> event.</summary>
|
<summary></summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs.ProcessFailedKind">
|
<summary>
|
Gets the kind of process failure that has occurred.
|
</summary><remarks><c>ProcessFailedKind</c> is a combination of process kind (for example, browser, renderer, gpu) and failure (exit, unresponsiveness). Renderer processes are further divided in main frame renderer (<c>RenderProcessExited</c>, <c>RenderProcessUnresponsive</c>) and subframe renderer (<c>FrameRenderProcessExited</c>). To learn about the conditions under which each failure kind occurs, see <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind" />.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs.ExitCode">
|
<summary>
|
Gets the exit code of the failing process, for telemetry purposes.</summary><remarks>
|
The exit code is always <c>1</c> when <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs.ProcessFailedKind" /> is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.BrowserProcessExited" />, and <c>STILL_ACTIVE</c>(<c>259</c>) when <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs.ProcessFailedKind" /> is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.RenderProcessUnresponsive" />.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs.FrameInfosForFailedProcess">
|
<summary>
|
Gets the collection of <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2FrameInfo" />s for frames in the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2" /> that were being rendered by the failed process.
|
</summary><remarks>
|
The content in these frames is replaced with an error page.
|
This is only available when <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs.ProcessFailedKind" /> is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.FrameRenderProcessExited" />; the returned collection is empty for all other process failure kinds, including the case in which the failed process was the renderer for the main frame and subframes within it, for which the failure kind is <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedKind.RenderProcessExited" />.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs.ProcessDescription">
|
<summary>
|
Gets a description of the failing process, assigned by the WebView2 Runtime.
|
</summary><remarks>
|
This is a technical English term appropriate for logging or development purposes, and not localized for the end user. It applies to utility processes (for example, "Audio Service", "Video Capture") and plugin processes (for example, "Flash"). The returned string is empty if the WebView2 Runtime did not assign a description to the process.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs.Reason">
|
<summary>
|
Gets the reason for the process failure.</summary><remarks>
|
Some of the reasons are only applicable to specific values of <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs.ProcessFailedKind" />, and the following <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs.ProcessFailedKind" /> values always return the indicated reason value:
|
<list type="table"><listheader><term>ProcessFailedKind</term><description>Reason</description></listheader><item><term><c>BrowserProcessExited</c></term><description><c>Unexpected</c></description></item><item><term><c>RenderProcessUnresponsive</c></term><description><c>Unresponsive</c></description></item></list>
|
For other <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs.ProcessFailedKind" /> values, the reason may be any of the reason values. To learn about what these values mean, see <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedReason" />.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessFailedEventArgs.FailureSourceModulePath">
|
<summary>
|
When ProcessFailed occurred due to a failed Code Integrity check, this property returns the full path of the file that was prevented from loading on the system.
|
The webview2 process which tried to load the DLL will fail with exit code STATUS_INVALID_IMAGE_HASH(-1073740760).</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ProcessInfo">
|
<summary>
|
Provides a set of properties for a process list in the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Environment" />.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessInfo.Kind">
|
<summary>The kind of the process.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ProcessInfo.ProcessId">
|
<summary>The process id of the process.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2Profile">
|
<summary>
|
Multiple profiles can be created under a single user data directory but with separated cookies, user preference settings, and various data storage etc.. If the CoreWebView2 was created with a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions" />, the CoreWebView2Profile will match those specified options. Otherwise if this CoreWebView2 was created without a <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ControllerOptions" />, then this will be the default CoreWebView2Profile for the corresponding CoreWebView2Environment.</summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.DefaultDownloadFolderPath">
|
<summary>
|
The default download folder path.
|
</summary><remarks>
|
The default value is the system default download folder path for the user. The default download folder path is persisted in the user data folder across sessions. The value should be an absolute path to a folder that the user and application can write to. Throws an exception if the value is invalid, and the default download path is not changed. Otherwise the path is changed immediately. If the directory does not yet exist, it is created at the time of the next download. If the host application does not have permission to create the directory, then the user is prompted to provide a new path through the Save As dialog. The user can override the default download folder path for a given download by choosing a different path in the Save As dialog.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.IsInPrivateModeEnabled">
|
<summary>
|
InPrivate mode is enabled or not.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.PreferredColorScheme">
|
<summary>
|
The PreferredColorScheme property sets the overall color scheme of the WebView2s associated with this profile.
|
</summary><remarks>
|
This sets the color scheme for WebView2 UI like dialogs, prompts, and menus by setting the media feature <c>prefers-color-scheme</c>.
|
The default value for this is <c>CoreWebView2PreferredColorScheme.Auto</c>, which will follow whatever color scheme the OS is currently set to.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.ProfileName">
|
<summary>
|
The name of the profile.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.ProfilePath">
|
<summary>
|
Full path of the profile directory.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Profile.ClearBrowsingDataAsync(Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds)">
|
<summary>
|
Clear the browsing data of the associated profile.</summary><remarks>
|
Clears browsing data on the profile the method is called on. Additional optional parameters include the start time and end time to clear the browsing data between as well as the data specific data kinds to clear on the profile. The method may be overloaded to take:
|
|
<list type="bullet"><item><description>
|
No parameters - in which the entirety of the data on the profile will be cleared.
|
</description></item><item><description>
|
The data kind(s) - in which the data kind(s) will be cleared for their entirety.
|
</description></item><item><description>
|
The data kind(s), start time, and end time - in which the data kind(s) will be cleared between the start and end time. The start time will be offset by -1.0 and the end time will be offset by +1.0 to include the last fractional second on each respective end. The start time is inclusive in the time period while the end time is exclusive.
|
</description></item></list>
|
|
The exposed methods are as follows:
|
<code>
|
ClearBrowsingDataAsync(CoreWebView2BrowsingDataKinds dataKinds);
|
ClearBrowsingDataAsync(CoreWebView2BrowsingDataKinds dataKinds, DateTime startTime, DateTime endTime);
|
ClearBrowsingDataAsync();
|
</code></remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Profile.ClearBrowsingDataAsync">
|
<summary>
|
Clear the entirety of the browsing data associated with the profile
|
it is called on. It clears the data regardless of timestamp.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.PreferredTrackingPreventionLevel">
|
<summary>
|
The <c>PreferredTrackingPreventionLevel</c> property allows you to control levels of tracking prevention for WebView2 which are associated with a profile. This level would apply to the context of the profile. That is, all WebView2s sharing the same profile will be affected and also the value is persisted in the user data folder.
|
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2TrackingPreventionLevel" /> for descriptions of levels.
|
</summary><remarks>
|
If tracking prevention feature is enabled when creating the WebView2 environment, you can also disable tracking prevention later using this property and <c>CoreWebView2TrackingPreventionLevel.None</c> value but that doesn't improves runtime performance.
|
|
There is <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.EnableTrackingPrevention" /> property to enable/disable tracking prevention feature for all the WebView2's created in the same environment. If enabled, PreferredTrackingPreventionLevel is set to <c>CoreWebView2TrackingPreventionLevel.Balanced</c> by default for all the WebView2's and profiles created in the same environment or is set to the level whatever value was last changed/persisted to the profile. If disabled PreferredTrackingPreventionLevel is not respected by WebView2. If PreferredTrackingPreventionLevel is set when the feature is disabled, the property value get changed and persisted but it will takes effect only if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.EnableTrackingPrevention" /> is true.
|
|
See <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.EnableTrackingPrevention" /> for more details.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Profile.SetPermissionStateAsync(Microsoft.Web.WebView2.Core.CoreWebView2PermissionKind,System.String,Microsoft.Web.WebView2.Core.CoreWebView2PermissionState)">
|
<summary>
|
Sets permission state for the given permission kind and origin asynchronously.
|
</summary><remarks>
|
The state change persists across sessions until it is changed by another call to `SetPermissionState`, or by setting the `State` property in `PermissionRequestedEventArgs`. Setting the state to <c>CoreWebView2PermissionState.Default</c> will erase any state saved in the profile and restore the default behavior. The origin should have a valid scheme and host (e.g. "https://www.example.com"), otherwise the method fails. Additional URI parts like path and fragment are ignored. For example, "https://wwww.example.com/app1/index.html/" is treated the same as "https://wwww.example.com". See the [MDN origin definition](https://developer.mozilla.org/docs/Glossary/Origin) for more details.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Profile.GetNonDefaultPermissionSettingsAsync">
|
<summary>
|
Invokes the handler with a collection of all nondefault permission settings.
|
</summary><remarks>
|
Use this method to get the permission state set in the current and previous sessions.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.CookieManager">
|
<summary>
|
Get the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager" /> which Creates, adds or updates, gets, or or view the cookies for the current profile.
|
</summary><remarks>
|
All CoreWebView2s associated with this profile share the same cookie values. Changes to cookies in this cookie manager apply to all CoreWebView2s associated with this profile.
|
</remarks><seealso cref="T:Microsoft.Web.WebView2.Core.CoreWebView2CookieManager" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.IsGeneralAutofillEnabled">
|
<summary>
|
Determines whether general form information will be saved and autofilled.
|
</summary><remarks>
|
General autofill information includes information like names, street and email addresses, phone numbers, and arbitrary input. This excludes password information. When disabled, no suggestions appear, and no new information is saved.
|
When enabled, information is saved, suggestions appear, and clicking on one will populate the form fields. The default value is <c>true</c>. It will apply immediately after setting.
|
This property has the same value as <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsGeneralAutofillEnabled" />, and changing one will change the other. All WebView2s with the same <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Profile" /> will share the same value for this property, so for the WebView2s with the same profile, their <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsGeneralAutofillEnabled" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.IsGeneralAutofillEnabled" /> will always have the same value.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.IsPasswordAutosaveEnabled">
|
<summary>
|
Determines whether password information will be autosaved.
|
</summary><remarks>
|
When disabled, no new password data is saved and no Save/Update Password prompts are displayed. However, if there was password data already saved before disabling this setting, then that password information is auto-populated, suggestions are shown and clicking on one will populate the fields.
|
When enabled, password information is auto-populated, suggestions are shown and clicking on one will populate the fields, new data is saved, and a Save/Update Password prompt is displayed. The default value is <c>false</c>. It will apply immediately after setting.
|
This property has the same value as <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsPasswordAutosaveEnabled" />, and changing one will change the other. All WebView2s with the same <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Profile" /> will share the same value for this property, so for the WebView2s with the same profile, their <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsPasswordAutosaveEnabled" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.IsPasswordAutosaveEnabled" /> will always have the same value.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Profile.AddBrowserExtensionAsync(System.String)">
|
<summary>
|
Add a browser extension to the current user profile from <c>extensionFolderPath</c>.</summary><param name="extensionFolderPath">The manifest.json folder path.</param><remarks>
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2BrowserExtension" /> for descriptions of browser extensions.
|
Adds the [browser extension](https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions) using the extension path for unpacked extensions from the local device. Extension is running right after installation.
|
The extension folder path is the topmost folder of an unpacked browser extension and contains the browser extension manifest file.
|
If the <c>extensionFolderPath</c> is an invalid path or doesn't contain the extension manifest.json file, this function will return <c>ERROR_FILE_NOT_FOUND</c> to callers.
|
Installed extension will default <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2BrowserExtension.IsEnabled" /> to true. When <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.AreBrowserExtensionsEnabled" /> is <c>false</c>, <c>AddBrowserExtension</c> will fail and return HRESULT <c>ERROR_NOT_SUPPORTED</c>.
|
During installation, the content of the extension is not copied to the user data folder. Once the extension is installed, changing the content of the extension will cause the extension to be removed from the installed profile.
|
When an extension is added the extension is persisted in the corresponding profile. The extension will still be installed the next time you use this profile.
|
When an extension is installed from a folder path, adding the same extension from the same folder path means reinstalleing this extension. When two extensions with the same Id are installed, only the later installed extension will be kept.
|
The following summarizes the possible error values that can be returned from <c>AddBrowserExtension</c> and a description of why these errors occur.
|
<list type="table"><listheader><description>Error value</description><description>Description</description></listheader><item><description><c>HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)</c></description><description>Extensions are disabled.</description></item><item><description><c>HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND)</c></description><description>Cannot find <c>manifest.json</c> file or it is not a valid extension manifest.</description></item><item><description><c>E_ACCESSDENIED</c></description><description>Cannot load extension with file or directory name starting with <c>_</c>, reserved for use by the system.</description></item><item><description><c>E_FAIL</c></description><description>Extension failed to install with other unknown reasons.</description></item></list></remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Profile.GetBrowserExtensionsAsync">
|
<summary>
|
Gets a snapshot of the set of extensions on current user profile.
|
|
See <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2BrowserExtension" /> for descriptions of browser extensions.
|
</summary><remarks>
|
Gets a snapshot of the set of extensions installed at the time <c>GetBrowserExtensions</c> is called. If an extension is installed or uninstalled after <c>GetBrowserExtensions</c> completes, the list returned by <c>GetBrowserExtensions</c> remains the same. When <c>AreBrowserExtensionsEnabled</c> is <c>false</c>, <c>GetBrowserExtensions</c> won't return any extensions on current user profile.
|
</remarks>
|
</member>
|
<member name="E:Microsoft.Web.WebView2.Core.CoreWebView2Profile.Deleted">
|
<summary>
|
Raised when profile is marked for deletion.
|
</summary><remarks>
|
When this event is raised, the CoreWebView2Profile and its corresponding CoreWebView2s have been closed, and cannot be used anymore.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Profile.Delete">
|
<summary>
|
Delete this profile and close the corresponding CoreWebView2s.
|
</summary><remarks>
|
After the API is called, the profile will be marked for deletion. The local profile's directory will be deleted at browser process exit. If it fails to delete, because something else is holding the files open, WebView2 will try to delete the profile at all future browser process starts until successful. The corresponding CoreWebView2s will be closed and the CoreWebView2Profile.Deleted event will be raised. See `CoreWebView2Profile.Deleted` for more information. If you try to create a new profile with the same name as an existing profile that has been marked as deleted but hasn't yet been deleted, profile creation will fail with HRESULT_FROM_WIN32(ERROR_DELETE_PENDING).
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2Profile.ClearBrowsingDataAsync(Microsoft.Web.WebView2.Core.CoreWebView2BrowsingDataKinds,System.DateTime,System.DateTime)">
|
<summary>
|
Clear the browsing data for the specified dataKinds between the
|
startTime and endTime. Overload the ClearBrowsingDataAsync method to
|
allow for additional time parameters.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIShowingEventArgs">
|
<summary>The event args for `SaveAsUIShowing` event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIShowingEventArgs.AllowReplace">
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIShowingEventArgs.Cancel">
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIShowingEventArgs.ContentMimeType">
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIShowingEventArgs.Kind">
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIShowingEventArgs.SaveAsFilePath">
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIShowingEventArgs.SuppressDefaultDialog">
|
<summary></summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2SaveAsUIShowingEventArgs.GetDeferral">
|
<summary></summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2SaveFileSecurityCheckStartingEventArgs">
|
<summary>The event args for `SaveFileSecurityCheckStarting` event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveFileSecurityCheckStartingEventArgs.CancelSave">
|
<summary>
|
Set if cancel the upcoming save/download.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveFileSecurityCheckStartingEventArgs.DocumentOriginUri">
|
<summary>Get the document origin URI of this file save operation.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveFileSecurityCheckStartingEventArgs.FileExtension">
|
<summary>
|
Get the extension of file to be saved.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveFileSecurityCheckStartingEventArgs.FilePath">
|
<summary>
|
Get the full path of file to be saved. This includes the file name and extension.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SaveFileSecurityCheckStartingEventArgs.SuppressDefaultPolicy">
|
<summary>
|
Set if the default policy checking and security warning will be suppressed.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2SaveFileSecurityCheckStartingEventArgs.GetDeferral">
|
<summary>
|
Gets a Deferral object.
|
</summary><remarks>
|
It will put the event into a deferred state. The default policy checking and any default UI will be blocked temporarily, saving file to local won't start, until the deferral is completed.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ScreenCaptureStartingEventArgs">
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScreenCaptureStartingEventArgs.Cancel">
|
<summary>
|
The host may set this flag to cancel the screen capture. If canceled,
|
the screen capture UI is not displayed regardless of the
|
<see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ScreenCaptureStartingEventArgs.Handled" /> property.
|
On the script side, it will return with a NotAllowedError as Permission denied.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScreenCaptureStartingEventArgs.Handled">
|
<summary>
|
By default, both the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ScreenCaptureStarting" /> event handlers on the
|
<see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Frame" /> and the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2" /> will be invoked, with the
|
<see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Frame" /> event handlers invoked first. The host may
|
set this flag to TRUE within the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Frame" /> event handlers
|
to prevent the remaining <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2" /> event handlers from being
|
invoked. If the flag is set to FALSE within the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Frame" />
|
event handlers, downstream handlers can update the <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ScreenCaptureStartingEventArgs.Cancel" /> property.
|
|
If a deferral is taken on the event args, then you must synchronously
|
set <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ScreenCaptureStartingEventArgs.Handled" /> to TRUE prior to taking your deferral to prevent the
|
<see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Frame" />s event handlers from being invoked.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScreenCaptureStartingEventArgs.OriginalSourceFrameInfo">
|
<summary>
|
The associated frame information that requests the screen capture
|
permission. This can be used to get the frame source, name, frameId,
|
and parent frame information.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2ScreenCaptureStartingEventArgs.GetDeferral">
|
<summary>
|
Gets a Deferral object. Use this deferral to
|
defer the decision to show the Screen Capture UI. getDisplayMedia()
|
won't call its callbacks until the deferral is completed.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogOpeningEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ScriptDialogOpening" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogOpeningEventArgs.DefaultText">
|
<summary>
|
Gets the default value to use for the result of the <c>prompt</c> JavaScript function.
|
</summary><remarks>
|
This is the second parameter passed to the JavaScript prompt dialog.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogOpeningEventArgs.Kind">
|
<summary>
|
Gets the kind of JavaScript dialog box.
|
</summary><seealso cref="T:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogKind" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogOpeningEventArgs.Message">
|
<summary>
|
Gets the message of the dialog box.
|
</summary><remarks>
|
From JavaScript this is the first parameter passed to <c>alert</c>, <c>confirm</c>, and <c>prompt</c> and is empty for <c>beforeunload</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogOpeningEventArgs.ResultText">
|
<summary>
|
Gets or sets the return value from the JavaScript <c>prompt</c> function if <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogOpeningEventArgs.Accept" /> is run.</summary><remarks>
|
This value is ignored for <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogOpeningEventArgs.Kind" />s other than <see cref="F:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogKind.Prompt" />. If <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogOpeningEventArgs.Accept" /> is not run, this value is ignored and <c>false</c> is returned from <c>prompt</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogOpeningEventArgs.Uri">
|
<summary>
|
Gets the URI of the page that requested the dialog box.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogOpeningEventArgs.Accept">
|
<summary>
|
Responds with **OK** to <c>confirm</c>, <c>prompt</c>, and <c>beforeunload</c> dialogs. Not run this method to indicate cancel.
|
</summary><remarks>
|
From JavaScript, this means that the <c>confirm</c> function and <c>beforeunload</c> event returns <c>true</c> if Accept is run. And for the <c>prompt</c> function it returns the value of <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogOpeningEventArgs.ResultText" /> if Accept is run and otherwise returns <c>false</c>.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2ScriptDialogOpeningEventArgs.GetDeferral">
|
<summary>
|
Gets a Deferral object.
|
Use this to Complete the event at a later time.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ScriptException">
|
<summary>This represents a JavaScript exception.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScriptException.ColumnNumber">
|
<summary>The column number of the source where the exception occurred. Note that this position starts at 0.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScriptException.LineNumber">
|
<summary>The line number of the source where the exception occurred. Note that this position starts at 0.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScriptException.Message">
|
<summary>The Message is the exception's message and potentially stack.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScriptException.Name">
|
<summary>The Name is the exception's class name.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ScriptException.ToJson">
|
<summary>This will return all details of the exception as a JSON string.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2ServerCertificateErrorDetectedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ServerCertificateErrorDetected" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ServerCertificateErrorDetectedEventArgs.Action">
|
<summary>The action of the server certificate error detection.
|
</summary><remarks>
|
The default value is <c>CoreWebView2ServerCertificateErrorAction.Default</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ServerCertificateErrorDetectedEventArgs.ErrorStatus">
|
<summary>The TLS error code for the invalid certificate.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ServerCertificateErrorDetectedEventArgs.RequestUri">
|
<summary>URI associated with the request for the invalid certificate.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2ServerCertificateErrorDetectedEventArgs.ServerCertificate">
|
<summary>
|
Returns the server <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Certificate" />.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2ServerCertificateErrorDetectedEventArgs.GetDeferral">
|
<summary>
|
Gets a Deferral object.
|
Use this to Complete the event at a later time.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2Settings">
|
<summary>
|
Defines properties that enable, disable, or modify WebView features.
|
</summary><remarks>
|
Changes to <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsGeneralAutofillEnabled" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsPasswordAutosaveEnabled" /> will take effect immediately, while other setting changes made after <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.NavigationStarting" /> event do not apply until the next top-level navigation.
|
</remarks>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.AreDefaultContextMenusEnabled">
|
<summary>
|
Determines whether the default context menus are shown to the user in WebView.
|
</summary><remarks>
|
The default value is <c>true</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.AreDefaultScriptDialogsEnabled">
|
<summary>
|
Determines whether WebView renders the default JavaScript dialog box.
|
</summary><remarks>
|
This is used when loading a new HTML document. If set to <c>false</c>, WebView does not render the default JavaScript dialog box (specifically those displayed by the JavaScript alert, confirm, prompt functions and <c>beforeunload</c> event). Instead, WebView raises <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ScriptDialogOpening" /> event that contains all of the information for the dialog and allow the host app to show a custom UI. The default value is <c>true</c>.
|
</remarks><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.ScriptDialogOpening" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.AreDevToolsEnabled">
|
<summary>
|
Determines whether the user is able to use the context menu or keyboard shortcuts to open the DevTools window.
|
</summary><remarks>
|
The default value is <c>true</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.AreHostObjectsAllowed">
|
<summary>
|
Determines whether host objects are accessible from the page in WebView.
|
</summary><remarks>
|
The default value is <c>true</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsBuiltInErrorPageEnabled">
|
<summary>
|
Determines whether to disable built in error page for navigation failure and render process failure.
|
</summary><remarks>
|
When disabled, blank page is displayed when related error happens. The default value is <c>true</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsScriptEnabled">
|
<summary>
|
Determines whether running JavaScript is enabled in all future navigations in the WebView.
|
</summary><remarks>
|
This only affects scripts in the document. Scripts injected with <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.ExecuteScriptAsync(System.String)" /> runs even if script is disabled. The default value is <c>true</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsStatusBarEnabled">
|
<summary>
|
Determines whether the status bar is displayed.
|
</summary><remarks>
|
The status bar is usually displayed in the lower left of the WebView and shows things such as the URI of a link when the user hovers over it and other information. The default value is <c>true</c>. The status bar UI can be altered by web content and should not be considered secure.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsWebMessageEnabled">
|
<summary>
|
Determines whether communication from the host to the top-level HTML document of the WebView is allowed.
|
</summary><remarks>
|
This is used when loading a new HTML document. If set to <c>true</c>, communication from the host to the top-level HTML document of the WebView is allowed using <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsJson(System.String)" />, <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsString(System.String)" />, and message event of <c>window.chrome.webview</c>. Communication from the top-level HTML document of the WebView to the host is allowed using <c>window.chrome.webview.postMessage</c> function and the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebMessageReceived" /> event. If set to <c>false</c>, then communication is disallowed. <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsJson(System.String)" /> and <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsString(System.String)" /> fail and <c>window.chrome.webview.postMessage</c> fails by throwing an instance of an Error object. The default value is <c>true</c>.
|
</remarks><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsJson(System.String)" /><seealso cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostWebMessageAsString(System.String)" /><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebMessageReceived" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsZoomControlEnabled">
|
<summary>
|
Determines whether the user is able to impact the zoom of the WebView.
|
</summary><remarks>
|
When disabled, the user is not able to zoom using Ctrl++, Ctr+-, or Ctrl+mouse wheel, but the zoom is set using <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor" /> property. The default value is <c>true</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.UserAgent">
|
<summary>
|
Determines WebView2's User Agent.
|
</summary><remarks>
|
The default value is the default User Agent of the Edge browser. This property may be overridden if the User-Agent header is set in a request. If the parameter is empty the User Agent will not be updated and the current User Agent will remain. Setting this property may clear User Agent Client Hints headers Sec-CH-UA-* and script values from navigator.userAgentData. Current implementation behavior is subject to change. By default, the User Agent set will also be effective on the Service Worker associated with the WebView. If there are multiple WebViews associated with the same service worker, the last User Agent set will be used. To disable this behavior, disable the feature flag <c>msWebView2SetUserAgentOverrideOnServiceWorker</c>.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.AreBrowserAcceleratorKeysEnabled">
|
<summary>
|
Determines whether browser-specific accelerator keys are enabled.</summary><remarks>
|
When this setting is set to <c>false</c>, it disables all accelerator keys that access features specific to a web browser, including but not limited to:
|
|
<list type="bullet"><item><description>Ctrl+F and F3 for Find on Page</description></item><item><description>Ctrl+P for Print</description></item><item><description>Ctrl+R and F5 for Reload</description></item><item><description>Ctrl+Plus and Ctrl+Minus for zooming</description></item><item><description>Ctrl+Shift-C and F12 for DevTools</description></item><item><description>Special keys for browser functions, such as Back, Forward, and Search</description></item></list>
|
|
It does not disable accelerator keys related to movement and text editing, such as:
|
|
<list type="bullet"><item><description>Home, End, Page Up, and Page Down</description></item><item><description>Ctrl+X, Ctrl+C, Ctrl+V</description></item><item><description>Ctrl+A for Select All</description></item><item><description>Ctrl+Z for Undo</description></item></list>
|
|
Those accelerator keys will always be enabled unless they are handled in the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.AcceleratorKeyPressed" /> event.
|
|
This setting has no effect on the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.AcceleratorKeyPressed" /> event. The event will be fired for all accelerator keys, whether they are enabled or not.
|
|
The default value of <c>AreBrowserAcceleratorKeysEnabled</c> is true.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsGeneralAutofillEnabled">
|
<summary>
|
Determines whether general form information will be saved and autofilled.
|
</summary><remarks>
|
General autofill information includes information like names, street and email addresses, phone numbers, and arbitrary input. This excludes password information. When disabled, no suggestions appear, and no new information is saved.
|
When enabled, information is saved, suggestions appear, and clicking on one will populate the form fields. The default value is <c>true</c>. It will apply immediately after setting.
|
This property has the same value as <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.IsGeneralAutofillEnabled" />, and changing one will change the other. And all WebView2s that created with the same <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Profile" /> will share the same value for this property, so for the WebView2s with the same profile, their <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsGeneralAutofillEnabled" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.IsGeneralAutofillEnabled" /> will always have the same value.
|
</remarks><seealso cref="E:Microsoft.Web.WebView2.Core.CoreWebView2Controller.AcceleratorKeyPressed" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsPasswordAutosaveEnabled">
|
<summary>
|
Determines whether password information will be autosaved.
|
</summary><remarks>
|
When disabled, no new password data is saved and no Save/Update Password prompts are displayed. However, if there was password data already saved before disabling this setting, then that password information is auto-populated, suggestions are shown and clicking on one will populate the fields.
|
When enabled, password information is auto-populated, suggestions are shown and clicking on one will populate the fields, new data is saved, and a Save/Update Password prompt is displayed. The default value is <c>false</c>. It will apply immediately after setting.
|
This property has the same value as <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.IsPasswordAutosaveEnabled" />, and changing one will change the other. All WebView2s with the same <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2Profile" /> will share the same value for this property, so for the WebView2s with the same profile, their <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsPasswordAutosaveEnabled" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Profile.IsPasswordAutosaveEnabled" /> will always have the same value.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsPinchZoomEnabled">
|
<summary>
|
Determines the ability of the end users to use pinching motions on touch input enabled devices to scale the web content in the WebView2.
|
</summary><remarks>
|
When disabled, the end users cannot use pinching motions on touch input enabled devices to scale the web content in the WebView2. The default value is <c>true</c>.
|
Pinch-zoom, referred to as "Page Scale" zoom, is performed as a post-rendering step, it changes the page scale factor property and scales the surface the web page is rendered onto when user performs a pinch zooming action. It does not change the layout but rather changes the viewport and clips the web content, the content outside of the viewport isn't visible onscreen and users can't reach this content using mouse. This API only affects the Page Scale zoom and has no effect on the existing browser zoom properties (<see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsZoomControlEnabled" /> and <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2Controller.ZoomFactor" />) or other end user mechanisms for zooming.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsSwipeNavigationEnabled">
|
<summary>
|
Determines whether the end user to use swiping gesture on touch input enabled devices to navigate in WebView2.
|
</summary><remarks>
|
Swiping gesture navigation on touch screen includes:
|
|
<list type="bullet"><item><description>
|
Swipe left/right (swipe horizontally) to navigate to previous/next page in navigation history.
|
</description></item><item><description>
|
Pull to refresh (swipe vertically) the current page. (This feature is currently disabled by default in the browser, to enable in WebView2, set <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2EnvironmentOptions.AdditionalBrowserArguments" /> property with <c>--pull-to-refresh</c> switch).
|
</description></item></list>
|
It defaults to <c>true</c>. When set to <c>false</c>, the end user cannot swipe to navigate or pull to refresh. This API only affects the overscrolling navigation functionality and has no effect on the scrolling interaction used to explore the web content shown in WebView2.
|
</remarks><example>
|
:::code language="csharp" source="../code/sample/SampleApps/WebView2WpfBrowser/MainWindow.xaml.cs" id="ToggleSwipeNavigationEnabled":::
|
</example>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.HiddenPdfToolbarItems">
|
<summary>
|
Used to customize the PDF toolbar items.
|
</summary><remarks>
|
By default, it is <c>CoreWebView2PdfToolbarItems.None</c> and so it displays all of the items.
|
Changes to this property apply to all CoreWebView2s in the same environment and using the same profile.
|
Changes to this setting apply only after the next navigation.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsReputationCheckingRequired">
|
<summary>
|
Determines whether SmartScreen is enabled when visiting web pages
|
</summary><remarks>
|
The default value is <c>true</c>.
|
IsReputationCheckingRequired is used to control whether SmartScreen is enabled or not.
|
SmartScreen is enabled or disabled for all CoreWebView2s using the same user data folder.
|
If CoreWebView2Setting.IsReputationCheckingRequired is <c>true</c> for any CoreWebView2 using the same user data folder, then SmartScreen is enabled. If CoreWebView2Setting.IsReputationCheckingRequired is <c>false</c> for all CoreWebView2 using the same user data folder, then SmartScreen is disabled.
|
When it is changed, the change will be applied to all WebViews using the same user data folder on the next navigation or download.
|
If the newly created CoreWebview2 does not set SmartScreen to <c>false</c>, when navigating(Such as Navigate(), LoadDataUrl(), ExecuteScript(), etc.), the default value will be applied to all CoreWebview2 using the same user data folder.
|
SmartScreen of WebView2 apps can be controlled by Windows system setting "SmartScreen for Microsoft Edge", specially, for WebView2 in Windows Store apps, SmartScreen is controlled by another Windows system setting "SmartScreen for Microsoft Store apps". When the Windows setting is enabled, the SmartScreen operates under the control of the `IsReputationCheckingRequired`. When the Windows setting is disabled, the SmartScreen will be disabled regardless of the `IsReputationCheckingRequired` value set in WebView2 apps. In other words, under this circumstance the value of `IsReputationCheckingRequired` will be saved but overridden by system setting. Upon re-enabling the Windows setting, the CoreWebview2 will reference the `IsReputationCheckingRequired` to determine the SmartScreen status.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2Settings.IsNonClientRegionSupportEnabled">
|
<summary>
|
The `IsNonClientRegionSupportEnabled` property enables web pages to use the
|
`app-region` CSS style. Disabling/Enabling the `IsNonClientRegionSupportEnabled`
|
takes effect after the next navigation. Defaults to `false`.
|
|
When this property is `TRUE`, then all the non-client region features
|
will be enabled:
|
Draggable Regions will be enabled, they are regions on a webpage that
|
are marked with the CSS attribute `app-region: drag/no-drag`. When set to
|
`drag`, these regions will be treated like the window's title bar, supporting
|
dragging of the entire WebView and its host app window; the system menu shows
|
upon right click, and a double click will trigger maximizing/restoration of the
|
window size.
|
|
When set to `false`, all non-client region support will be disabled.
|
The `app-region` CSS style will be ignored on web pages.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer">
|
<summary>
|
A shared memory based buffer object that is created by <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateSharedBuffer(System.UInt64)" />. The object is presented to script as ArrayBuffer when posted to script with <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2.PostSharedBufferToScript(Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer,Microsoft.Web.WebView2.Core.CoreWebView2SharedBufferAccess,System.String)" />.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer.Buffer">
|
<summary>
|
A Windows.Foundation.IMemoryBufferReference object to access the underlying memory of the shared buffer as an array of bytes.
|
</summary><remarks>
|
Normal app should use <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer.OpenStream" /> to get a stream object to access the buffer.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer.Size">
|
<summary>
|
The size of the shared buffer in bytes.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer.OpenStream">
|
<summary>
|
Get an stream object that can be used to access the shared buffer.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer.Close">
|
<summary></summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer.Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer.Dispose(System.Boolean)">
|
<summary>
|
Protected implementation of Dispose pattern.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer.FileMappingHandle">
|
<summary>
|
The file mapping handle of the shared memory of the buffer.
|
</summary>
|
<remarks>
|
Normal app should use <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2SharedBuffer.OpenStream"/> to
|
get a stream object to access the buffer.
|
For advanced scenarios, you could use native file mapping APIs to obtain
|
other views or duplicate this handle to another application process and
|
create a view from the duplicated handle in that process to access the buffer
|
from that separate process.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2SourceChangedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.SourceChanged" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2SourceChangedEventArgs.IsNewDocument">
|
<summary><c>true</c> if the page being navigated to is a new document.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2WebMessageReceivedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebMessageReceived" /> event.</summary>
|
<summary></summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebMessageReceivedEventArgs.Source">
|
<summary>
|
Gets the URI of the document that sent this web message.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebMessageReceivedEventArgs.WebMessageAsJson">
|
<summary>
|
Gets the message posted from the WebView content to the host converted to a JSON string.
|
</summary><remarks>
|
Run this operation to communicate using JavaScript objects.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2WebMessageReceivedEventArgs.TryGetWebMessageAsString">
|
<summary>
|
Gets the message posted from the WebView content to the host as a string.
|
<returns>The message posted from the WebView content to the host.</returns><exception cref="T:System.ArgumentException">The message posted is some other kind of JavaScript type.</exception></summary><remarks>
|
Run this operation to communicate using simple strings.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebMessageReceivedEventArgs.AdditionalObjects">
|
<summary>
|
Additional received WebMessage objects.
|
</summary><remarks>
|
To pass <c>AdditionalObjects</c> via WebMessage to the app, use the <c>chrome.webview.postMessageWithAdditionalObjects</c> content API. Any DOM object type that can be natively representable that has been passed in to <c>additionalObjects</c> parameter will be accessible here. Currently a WebMessage object can be the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2File" /> type.
|
Entries in the collection can be <c>nullptr</c> if <c>null</c> or <c>undefined</c> was passed. Cast the object to the native type to access its specific properties.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequest">
|
<summary>
|
An HTTP request used with the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequest.Content">
|
<summary>
|
Gets or sets the HTTP request message body as stream.
|
</summary><remarks>
|
POST data should be here. If a stream is set, which overrides the message body, the stream must have all the content data available by the time the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event deferral of this request is completed. Stream should be agile or be created from a background STA to prevent performance impact to the UI thread. <c>null</c> means no content data.
|
</remarks><seealso cref="T:System.IO.Stream" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequest.Headers">
|
<summary>Gets the mutable HTTP request headers.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequest.Method">
|
<summary>The HTTP request method.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequest.Uri">
|
<summary>The request URI.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event.</summary>
|
<summary>Event args for the `WebResourceRequested` event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestedEventArgs.Request">
|
<summary>
|
Gets the web resource request.
|
</summary><remarks>
|
The request object may be missing some headers that are added by network stack at a later time.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestedEventArgs.ResourceContext">
|
<summary>The web resource request context.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestedEventArgs.Response">
|
<summary>
|
Gets or sets the <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponse" /> object.
|
</summary><remarks>
|
If this object is set, the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event will be completed with this Response.
|
An empty <see cref="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponse" /> object can be created with <see cref="M:Microsoft.Web.WebView2.Core.CoreWebView2Environment.CreateWebResourceResponse(System.IO.Stream,System.Int32,System.String,System.String)" /> and then modified to construct the Response.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestedEventArgs.GetDeferral">
|
<summary>
|
Gets a Deferral object and put the event into a deferred state.
|
Use this to Complete the event at a later time.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceRequestedEventArgs.RequestedSourceKind">
|
<summary>The web resource requested source.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponse">
|
<summary>
|
An HTTP response used with the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponse.Content">
|
<summary>
|
Gets HTTP response content as stream.
|
</summary><remarks>
|
Stream must have all the content data available by the time the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event deferral of this response is completed. Stream should be agile or be created from a background thread to prevent performance impact to the UI thread. <c>null</c> means no content data.
|
When providing the response data, you should consider relevant HTTP request headers just like an HTTP server would do. For example, if the request was for a video resource in a HTML video element, the request may contain the [Range](https://developer.mozilla.org/docs/Web/HTTP/Headers/Range) header to request only a part of the video that is streaming. In this case, your response stream should be only the portion of the video specified by the range HTTP request headers and you should set the appropriate [Content-Range](https://developer.mozilla.org/docs/Web/HTTP/Headers/Content-Range) header in the response.
|
</remarks><seealso cref="T:System.IO.Stream" />
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponse.Headers">
|
<summary>Overridden HTTP response headers.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponse.ReasonPhrase">
|
<summary>The HTTP response reason phrase.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponse.StatusCode">
|
<summary>The HTTP response status code.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponseReceivedEventArgs">
|
<summary>
|
Event args for the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceResponseReceived" /> event.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponseReceivedEventArgs.Request">
|
<summary>
|
Gets the request object for the web resource, as committed.
|
</summary><remarks>
|
This includes headers added by the network stack that were not be included during the associated <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceRequested" /> event, such as Authentication headers. Modifications to this object have no effect on how the request is processed as it has already been sent.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponseReceivedEventArgs.Response">
|
<summary>View of the response object received for the web resource.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponseView">
|
<summary>
|
View of the HTTP representation for a web resource response.
|
</summary><remarks>
|
The properties of this object are not mutable. This response view is used with the <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.WebResourceResponseReceived" /> event.
|
</remarks>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponseView.Headers">
|
<summary>The HTTP response headers as received.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponseView.ReasonPhrase">
|
<summary>The HTTP response reason phrase.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponseView.StatusCode">
|
<summary>The HTTP response status code.</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2WebResourceResponseView.GetContentAsync">
|
<summary>
|
Gets the response content stream asynchronously.
|
<exception cref="T:System.Runtime.InteropServices.COMException">The content failed to load.</exception></summary><remarks>
|
A <c>null</c> stream means no content was found. Note content (if any) for redirect responses is ignored.
|
This method returns <c>null</c> if content size is more than 123MB. If <c>msWebView2EnableDownloadContentInWebResourceResponseReceived</c> feature flag is disabled, for navigations that become downloads or if response is downloadable content type (e.g., application/octet-stream), this method also returns <c>null</c>. See <see cref="E:Microsoft.Web.WebView2.Core.CoreWebView2.DownloadStarting" /> event to handle the response or enable the feature flag. The Stream object that is returned will be thread-safe and as reads will be blocking while waiting for data to be available, it is recommended to read from a background thread.
|
If this method is being called again before a first call has completed, it will complete at the same time all prior calls do.
|
If this method is being called after a first call has completed, it will return immediately (asynchronously).
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures">
|
<summary>
|
The window features for a WebView popup window.
|
</summary><remarks>
|
The fields match the <c>windowFeatures</c> passed to <c>window.open()</c> as specified in [Window features](https://developer.mozilla.org/docs/Web/API/Window/open#Window_features) on MDN.
|
</remarks>
|
There is no requirement for you to respect the values. If your app does
|
not have corresponding UI features (for example, no toolbar) or if all
|
instance of WebView are opened in tabs and do not have distinct size or
|
positions, then your app does not respect the values. You may want to
|
respect values, but perhaps only some apply to the UI of you app.
|
Accordingly, you may respect all, some, or none of the properties as
|
appropriate for your app. For all numeric properties, if the value that is
|
passed to `window.open` is outside the range of an unsigned 32bit int, the
|
resulting value is the absolute value of the maximum for unsigned 32bit
|
integer. If you are not able to parse the value an integer, it is
|
considered `0`. If the value is a floating point value, it is rounded down
|
to an integer.
|
|
In runtime versions 98 or later, the values of `ShouldDisplayMenuBar`,
|
`ShouldDisplayStatus`, `ShouldDisplayToolbar`, and `ShouldDisplayScrollBars`
|
will not directly depend on the equivalent fields in the `windowFeatures`
|
string. Instead, they will all be false if the window is expected to be a
|
popup, and true if it is not.
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.HasPosition">
|
<summary>Indicates whether the left and top values are specified.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.HasSize">
|
<summary>Indicates whether the height and width values are specified.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.Height">
|
<summary>
|
Gets the height of the window. Ignored if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.HasSize" /> is <c>false</c>.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.Left">
|
<summary>Specifies the left position of the window.
|
|
Ignored if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.HasPosition" /> is <c>false</c>.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.ShouldDisplayMenuBar">
|
<summary>Indicates that the menu bar is displayed.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.ShouldDisplayScrollBars">
|
<summary>Indicates that the scroll bars are displayed.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.ShouldDisplayStatus">
|
<summary>Indicates that the status bar is displayed.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.ShouldDisplayToolbar">
|
<summary>Indicates that the browser toolbar is displayed.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.Top">
|
<summary>Specifies the top position of the window.
|
|
Ignored if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.HasPosition" /> is <c>false</c>.</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.Width">
|
<summary>Specifies the width of the window.
|
|
Ignored if <see cref="P:Microsoft.Web.WebView2.Core.CoreWebView2WindowFeatures.HasSize" /> is <c>false</c>.</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2PhysicalKeyStatus">
|
<summary>
|
Contains the information packed into the LPARAM sent to a Win32 key event.
|
</summary>
|
<remarks>
|
For more information about <c>WM_KEYDOWN</c>, navigate to [WM_KEYDOWN message](/windows/win32/inputdev/wm-keydown).
|
</remarks>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PhysicalKeyStatus.RepeatCount">
|
<summary>
|
Specifies the repeat count for the current message.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PhysicalKeyStatus.ScanCode">
|
<summary>
|
Specifies the scan code.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PhysicalKeyStatus.IsExtendedKey">
|
<summary>
|
Indicates that the key is an extended key.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PhysicalKeyStatus.IsMenuKeyDown">
|
<summary>
|
Indicates that a menu key is held down (context code).
|
</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PhysicalKeyStatus.WasKeyDown">
|
<summary>
|
Indicates that the key was held down.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Web.WebView2.Core.CoreWebView2PhysicalKeyStatus.IsKeyReleased">
|
<summary>
|
Indicates that the key was released.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.CoreWebView2InitializationCompletedEventArgs">
|
<summary>
|
Event args for the CoreWebView2InitializationCompleted event.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.CoreWebView2InitializationCompletedEventArgs.#ctor(System.Exception)">
|
<summary>
|
Initializes a new instance of the CoreWebView2InitializationCompletedEventArgs class.
|
</summary>
|
<param name="ex">
|
Exception that occurred during initialization, or null if initialization was successful.
|
</param>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2InitializationCompletedEventArgs.IsSuccess">
|
<summary>
|
True if the init task completed successfully.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Web.WebView2.Core.CoreWebView2InitializationCompletedEventArgs.InitializationException">
|
<summary>
|
The exception thrown from the init task. If the task completed successfully, this property is null.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.HostObjectHelper">
|
<summary>
|
This class is deprecated; use CoreWebView2PrivateHostObjectHelper instead.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.ManagedIStream.#ctor(System.IO.Stream)">
|
<summary>
|
Constructor
|
</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.ManagedIStream.System#Runtime#InteropServices#ComTypes#IStream#Read(System.Byte[],System.Int32,System.IntPtr)">
|
<summary>
|
Read at most bufferSize bytes into buffer and return the effective
|
number of bytes read in bytesReadPtr (unless null).
|
</summary>
|
<remarks>
|
mscorlib disassembly shows the following MarshalAs parameters
|
void Read([Out, MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)] byte[] pv, int cb, IntPtr pcbRead);
|
This means marshaling code will have found the size of the array buffer in the parameter bufferSize.
|
</remarks>
|
<SecurityNote>
|
Critical: calls Marshal.WriteInt32 which LinkDemands, takes pointers as input
|
</SecurityNote>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.ManagedIStream.System#Runtime#InteropServices#ComTypes#IStream#Seek(System.Int64,System.Int32,System.IntPtr)">
|
<summary>
|
Move the stream pointer to the specified position.
|
</summary>
|
<remarks>
|
System.IO.stream supports searching past the end of the stream, like
|
OLE streams.
|
newPositionPtr is not an out parameter because the method is required
|
to accept NULL pointers.
|
</remarks>
|
<SecurityNote>
|
Critical: calls Marshal.WriteInt64 which LinkDemands, takes pointers as input
|
</SecurityNote>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.ManagedIStream.System#Runtime#InteropServices#ComTypes#IStream#SetSize(System.Int64)">
|
<summary>
|
Sets stream's size.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.ManagedIStream.System#Runtime#InteropServices#ComTypes#IStream#Stat(System.Runtime.InteropServices.ComTypes.STATSTG@,System.Int32)">
|
<summary>
|
Obtain stream stats.
|
</summary>
|
<remarks>
|
STATSG has to be qualified because it is defined both in System.Runtime.InteropServices and
|
System.Runtime.InteropServices.ComTypes.
|
The STATSTG structure is shared by streams, storages and byte arrays. Members irrelevant to streams
|
or not available from System.IO.Stream are not returned, which leaves only cbSize and grfMode as
|
meaningful and available pieces of information.
|
grfStatFlag is used to indicate whether the stream name should be returned and is ignored because
|
this information is unavailable.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.ManagedIStream.System#Runtime#InteropServices#ComTypes#IStream#Write(System.Byte[],System.Int32,System.IntPtr)">
|
<summary>
|
Write at most bufferSize bytes from buffer.
|
</summary>
|
<SecurityNote>
|
Critical: calls Marshal.WriteInt32 which LinkDemands, takes pointers as input
|
</SecurityNote>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.ManagedIStream.System#Runtime#InteropServices#ComTypes#IStream#Clone(System.Runtime.InteropServices.ComTypes.IStream@)">
|
<summary>
|
Create a clone.
|
</summary>
|
<remarks>
|
Not implemented.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.ManagedIStream.System#Runtime#InteropServices#ComTypes#IStream#CopyTo(System.Runtime.InteropServices.ComTypes.IStream,System.Int64,System.IntPtr,System.IntPtr)">
|
<summary>
|
Read at most bufferSize bytes from the receiver and write them to targetStream.
|
</summary>
|
<remarks>
|
Not implemented.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.ManagedIStream.System#Runtime#InteropServices#ComTypes#IStream#Commit(System.Int32)">
|
<summary>
|
Commit changes.
|
</summary>
|
<remarks>
|
Only relevant to transacted streams.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.ManagedIStream.System#Runtime#InteropServices#ComTypes#IStream#LockRegion(System.Int64,System.Int64,System.Int32)">
|
<summary>
|
Lock at most byteCount bytes starting at offset.
|
</summary>
|
<remarks>
|
Not supported by System.IO.Stream.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.ManagedIStream.System#Runtime#InteropServices#ComTypes#IStream#Revert">
|
<summary>
|
Undo writes performed since last Commit.
|
</summary>
|
<remarks>
|
Relevant only to transacted streams.
|
</remarks>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.ManagedIStream.System#Runtime#InteropServices#ComTypes#IStream#UnlockRegion(System.Int64,System.Int64,System.Int32)">
|
<summary>
|
Unlock the specified region.
|
</summary>
|
<remarks>
|
Not supported by System.IO.Stream.
|
</remarks>
|
</member>
|
<member name="T:Microsoft.Web.WebView2.Core.WebView2RuntimeNotFoundException">
|
<summary>
|
The exception that is thrown when an WebView2 Runtime installation is missing.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.WebView2RuntimeNotFoundException.#ctor">
|
<summary>
|
Initializes a new instance of the WebView2RuntimeNotFoundException class.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.WebView2RuntimeNotFoundException.#ctor(System.String)">
|
<summary>
|
Initializes a new instance of the WebView2RuntimeNotFoundException class with a specified error message.
|
</summary>
|
<param name="message">
|
The error message that explains the reason for the exception.
|
</param>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.WebView2RuntimeNotFoundException.#ctor(System.Exception)">
|
<summary>
|
Initializes a new instance of the WebView2RuntimeNotFoundException class with a reference to the inner exception that is the cause of this exception.
|
</summary>
|
<param name="inner">
|
The exception that is the cause of the current exception.
|
</param>
|
</member>
|
<member name="M:Microsoft.Web.WebView2.Core.WebView2RuntimeNotFoundException.#ctor(System.String,System.Exception)">
|
<summary>
|
Initializes a new instance of the WebView2RuntimeNotFoundException class with a specified error message and a reference to the inner exception that is the cause of this exception.
|
</summary>
|
<param name="message">
|
The error message that explains the reason for the exception.
|
</param>
|
<param name="inner">
|
The exception that is the cause of the current exception.
|
</param>
|
</member>
|
</members>
|
</doc>
|
