Partilhar via


Microsoft.Web.WebView2.Core Namespace

Classes

CoreWebView2

WebView2 enables you to host web content using the latest Microsoft Edge browser and web technology.

CoreWebView2AcceleratorKeyPressedEventArgs

Event args for the AcceleratorKeyPressed event.

CoreWebView2BasicAuthenticationRequestedEventArgs

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.

CoreWebView2BasicAuthenticationResponse

Represents a Basic HTTP authentication response that contains a user name and a password as according to RFC7617 (https://tools.ietf.org/html/rfc7617).

CoreWebView2BrowserExtension

Browser extension installed on current profile.

CoreWebView2BrowserProcessExitedEventArgs

Event args for the BrowserProcessExited event.

CoreWebView2Certificate

Represents a certificate and provides access to its metadata.

CoreWebView2ClientCertificate

Represents a client certificate that provides access to the client certificate metadata.

CoreWebView2ClientCertificateRequestedEventArgs

Event args for the ClientCertificateRequested event.

CoreWebView2CompositionController

This class is an extension of the CoreWebView2Controller class to support visual hosting.

CoreWebView2ContentLoadingEventArgs

Event args for the ContentLoading event.

CoreWebView2ContextMenuItem

Represents a context menu item of a context menu displayed by WebView.

CoreWebView2ContextMenuRequestedEventArgs

Event args for the ContextMenuRequested event.

CoreWebView2ContextMenuTarget

Represents the information regarding the context menu target. Includes the context selected and the appropriate data used for the actions of a context menu.

CoreWebView2Controller

This class is the owner of the CoreWebView2 object, and provides support for resizing, showing and hiding, focusing, and other functionality related to windowing and composition.

CoreWebView2ControllerOptions

Used to manage profile options that created by CreateCoreWebView2ControllerOptions().

CoreWebView2Cookie

Provides a set of properties that are used to manage a CoreWebView2Cookie.

CoreWebView2CookieList

A list of CoreWebView2Cookies.

CoreWebView2CookieManager

Creates, adds or updates, gets, or or view the cookies.

CoreWebView2CustomSchemeRegistration

Represents the registration of a custom scheme with the CoreWebView2Environment.

CoreWebView2DedicatedWorker
CoreWebView2Deferral

This is used to complete deferrals on event args that support getting deferrals using the GetDeferral method. This class implements IDisposable.

CoreWebView2DevToolsProtocolEventReceivedEventArgs

Event args for the DevToolsProtocolEventReceived event.

CoreWebView2DevToolsProtocolEventReceiver

A Receiver is created for a particular DevTools Protocol event and allows you to subscribe and unsubscribe from that event.

CoreWebView2DOMContentLoadedEventArgs

Event args for the DOMContentLoaded event.

CoreWebView2DownloadOperation

Represents a download operation. Gives access to a download's metadata and supports a user canceling, pausing, or resuming a download.

CoreWebView2DownloadStartingEventArgs

Event args for the DownloadStarting event.

CoreWebView2Environment

This represents the WebView2 Environment.

CoreWebView2EnvironmentOptions

Options used to create WebView2 Environment.

CoreWebView2ExecuteScriptResult

The result for ExecuteScriptWithResultAsync(String).

CoreWebView2File

Representation of a DOM File object passed via WebMessage.

CoreWebView2FileSystemHandle

Representation of a DOM FileSystemHandle object.

CoreWebView2Frame

CoreWebView2Frame provides direct access to the iframes information and handling.

CoreWebView2FrameCreatedEventArgs

Event args for the FrameCreated event.

CoreWebView2FrameInfo

Provides a set of properties for a frame in the CoreWebView2.

CoreWebView2HostObjectAsyncMethodContinuation
CoreWebView2HttpHeadersCollectionIterator

Iterator for a collection of HTTP headers.

CoreWebView2HttpRequestHeaders

HTTP request headers.

CoreWebView2HttpResponseHeaders

HTTP response headers.

CoreWebView2InitializationCompletedEventArgs

Event args for the CoreWebView2InitializationCompleted event.

CoreWebView2LaunchingExternalUriSchemeEventArgs

Event args for the LaunchingExternalUriScheme event.

CoreWebView2MoveFocusRequestedEventArgs

Event args for the MoveFocusRequested event.

CoreWebView2NavigationCompletedEventArgs

Event args for the NavigationCompleted event.

CoreWebView2NavigationStartingEventArgs

Event args for the NavigationStarting event.

CoreWebView2NewWindowRequestedEventArgs

Event args for the NewWindowRequested event.

CoreWebView2NonClientRegionChangedEventArgs

Event args for the NonClientRegionChanged event.

CoreWebView2Notification

An object that represents a HTML Notification object.

CoreWebView2NotificationReceivedEventArgs

Event args for the NotificationReceived.

CoreWebView2PermissionRequestedEventArgs

Event args for the PermissionRequested event.

CoreWebView2PermissionSetting

Provides a set of properties for a permission setting.

CoreWebView2PointerInfo

This mostly represents a combined win32 POINTER_INFO, POINTER_TOUCH_INFO, and POINTER_PEN_INFO object.

CoreWebView2PrintSettings

Settings used by the PrintToPdfAsync(String, CoreWebView2PrintSettings) method.

CoreWebView2ProcessExtendedInfo

Provides a set of properties for a process list with extended information in the .

CoreWebView2ProcessFailedEventArgs

Event args for the ProcessFailed event.

CoreWebView2ProcessInfo

Provides a set of properties for a process list in the CoreWebView2Environment.

CoreWebView2Profile
CoreWebView2RestartRequestedEventArgs
CoreWebView2SaveAsUIShowingEventArgs

The event args for SaveAsUIShowing event.

CoreWebView2SaveFileSecurityCheckStartingEventArgs

The event args for SaveFileSecurityCheckStarting event.

CoreWebView2ScreenCaptureStartingEventArgs
CoreWebView2ScriptDialogOpeningEventArgs

Event args for the ScriptDialogOpening event.

CoreWebView2ScriptException

This represents a JavaScript exception.

CoreWebView2ServerCertificateErrorDetectedEventArgs

Event args for the ServerCertificateErrorDetected event.

CoreWebView2ServiceWorkerRegistration
CoreWebView2Settings

Defines properties that enable, disable, or modify WebView features.

CoreWebView2SharedBuffer

A shared memory based buffer object that is created by CreateSharedBuffer(UInt64). The object is presented to script as ArrayBuffer when posted to script with PostSharedBufferToScript(CoreWebView2SharedBuffer, CoreWebView2SharedBufferAccess, String).

CoreWebView2SourceChangedEventArgs

Event args for the SourceChanged event.

CoreWebView2Texture

The texture that the host writes to so that the Renderer will render on it.

CoreWebView2TextureStream

CoreWebView2 Texture Stream.

CoreWebView2TextureStreamErrorReceivedEventArgs

Texture stream error event argument.

CoreWebView2TextureStreamWebTextureReceivedEventArgs

The event args for the WebTextureReceived event.

CoreWebView2UpdateRuntimeResult

The UpdateRuntime operation result.

CoreWebView2WebMessageReceivedEventArgs

Event args for the WebMessageReceived event.

CoreWebView2WebResourceRequest

An HTTP request used with the WebResourceRequested event.

CoreWebView2WebResourceRequestedEventArgs

Event args for the WebResourceRequested event.

CoreWebView2WebResourceResponse

An HTTP response used with the WebResourceRequested event.

CoreWebView2WebResourceResponseReceivedEventArgs

Event args for the WebResourceResponseReceived event.

CoreWebView2WebResourceResponseView

View of the HTTP representation for a web resource response.

CoreWebView2WebTexture

Web Texture that receives from the Javascript.

CoreWebView2WindowFeatures

The window features for a WebView popup window.

EdgeNotFoundException

The exception that is thrown when an Edge installation is missing.

WebView2RuntimeNotFoundException

The exception that is thrown when an WebView2 Runtime installation is missing.

Structs

CoreWebView2Color

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.

CoreWebView2Matrix4x4

Matrix that represents a 3D transform. This transform is used to calculate correct coordinates when calling CreateCoreWebView2PointerInfoFromPointerId. This is equivalent to a D2D1_MATRIX_4X4_F

CoreWebView2PhysicalKeyStatus

Contains the information packed into the LPARAM sent to a Win32 key event.

Enums

CoreWebView2BoundsMode

Mode for how the Bounds property is interpreted in relation to the RasterizationScale property.

CoreWebView2BrowserProcessExitKind

Specifies the browser process exit type used in the ICoreWebView2BrowserProcessExitedEventArgs interface.

CoreWebView2BrowsingDataKinds

Specifies the datatype for the ICoreWebView2Profile2::ClearBrowsingData method.

CoreWebView2CapturePreviewImageFormat

Specifies the image format for the ICoreWebView2::CapturePreview method.

CoreWebView2CertificateKind

The kind of the CoreWebView2Certificate.

CoreWebView2ChannelSearchKind

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.

CoreWebView2ClientCertificateKind

Specifies the client certificate kind.

CoreWebView2ContextMenuItemKind

Specifies the menu item kind for the ICoreWebView2ContextMenuItem::get_Kind method

CoreWebView2ContextMenuTargetKind

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.

CoreWebView2CookieSameSiteKind

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

CoreWebView2DefaultDownloadDialogCornerAlignment

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.

CoreWebView2DownloadInterruptReason

Reason why a download was interrupted.

CoreWebView2DownloadState

State of the download operation.

CoreWebView2FaviconImageFormat

Specifies the image format to use for favicon.

CoreWebView2FileSystemHandleKind

Kind of CoreWebView2FileSystemHandle as described in FileSystemHandle.kind.

CoreWebView2FileSystemHandlePermission

Allowed permissions of a CoreWebView2FileSystemHandle as described in FileSystemHandle.requestPermission().

CoreWebView2FrameKind

Indicates the frame type used in the ICoreWebView2FrameInfo interface.

CoreWebView2HostResourceAccessKind

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 still apply. The following table illustrates the host resource cross origin access according to access context and COREWEBVIEW2_HOST_RESOURCE_ACCESS_KIND.

        Cross Origin Access Context | DENY | ALLOW | DENY_CORS
        --- | --- | --- | ---
        From DOM like src of img, script or iframe element| Deny | Allow | Allow
        From Script like Fetch or XMLHttpRequest| Deny | Allow | Deny
CoreWebView2KeyEventKind

Specifies the key event type that triggered an AcceleratorKeyPressed event.

CoreWebView2MemoryUsageTargetLevel

Specifies memory usage target level of WebView.

CoreWebView2MouseEventKind

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.

CoreWebView2MouseEventVirtualKeys

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.

CoreWebView2MoveFocusReason

Specifies the reason for moving focus.

CoreWebView2NavigationKind

Specifies the navigation kind of each navigation.

CoreWebView2NonClientRegionKind

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.

CoreWebView2PdfToolbarItems

Specifies the PDF toolbar item types used for the ICoreWebView2Settings::put_HiddenPdfToolbarItems method.

CoreWebView2PermissionKind

Indicates the type of a permission request.

CoreWebView2PermissionState

Specifies the response to a permission request.

CoreWebView2PointerEventKind

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.

CoreWebView2PreferredColorScheme

An enum to represent the options for WebView2 color scheme: auto, light, or dark.

CoreWebView2PrintCollation

Specifies the collation for a print.

CoreWebView2PrintColorMode

Specifies the color mode for a print.

CoreWebView2PrintDialogKind

Specifies the print dialog kind.

CoreWebView2PrintDuplex

Specifies the duplex option for a print.

CoreWebView2PrintMediaSize

Specifies the media size for a print.

CoreWebView2PrintOrientation

The orientation for printing, used by the Orientation property on ICoreWebView2PrintSettings.

CoreWebView2PrintStatus

Indicates the status for printing.

CoreWebView2ProcessFailedKind

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.

CoreWebView2ProcessFailedReason

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.

CoreWebView2ProcessKind

Indicates the process type used in the ICoreWebView2ProcessInfo interface.

CoreWebView2ReleaseChannels

The WebView2 release channels. Use ReleaseChannels and ChannelSearchKind on ICoreWebView2EnvironmentOptions to control which channel is searched for during environment creation.

        |Channel|Primary purpose|How often updated with new features|
        |:---:|---|:---:|
        |Stable (WebView2 Runtime)|Broad Deployment|Monthly|
        |Beta|Flighting with inner rings, automated testing|Monthly|
        |Dev|Automated testing, selfhosting to test new APIs and features|Weekly|
        |Canary|Automated testing, selfhosting to test new APIs and features|Daily|
CoreWebView2RestartRequestedPriority

Specifies the restart requested priority level.

CoreWebView2SaveAsKind

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.
CoreWebView2SaveAsUIResult

Status of a programmatic Save As call. Indicates the result of the ShowSaveAsUI method.

CoreWebView2ScriptDialogKind

Specifies the JavaScript dialog type used in the ICoreWebView2ScriptDialogOpeningEventHandler interface.

CoreWebView2ScrollbarStyle

Set ScrollBar style on ICoreWebView2EnvironmentOptions during environment creation.

CoreWebView2ServerCertificateErrorAction

Specifies the action type when server certificate error is detected to be used in the ICoreWebView2ServerCertificateErrorDetectedEventArgs interface.

CoreWebView2SharedBufferAccess

Specifies the desired access from script to CoreWebView2SharedBuffer.

CoreWebView2TextDirectionKind

Indicates the text direction of the notification.

CoreWebView2TextureStreamErrorKind

Kinds of errors that can be reported by the ErrorReceived event.

CoreWebView2TrackingPreventionLevel

Tracking prevention levels.

CoreWebView2UpdateRuntimeStatus

Status of UpdateRuntime operation result.

CoreWebView2WebErrorStatus

Indicates the error status values for web navigations.

CoreWebView2WebResourceContext

Specifies the web resource request contexts.

CoreWebView2WebResourceRequestSourceKinds

Specifies the source of WebResourceRequested event.