WebView class
TOC
Collapse the table of content
Expand the table of content

WebView class

Provides a control that hosts HTML content in an app.

Inheritance

Object
  DependencyObject
    UIElement
      FrameworkElement
        WebView

Syntax


public sealed class WebView : FrameworkElement

Members

The WebView class has these types of members:

Constructors

The WebView class has these constructors.

ConstructorDescription
WebView Initializes a new instance of the WebView class.
WebView(WebViewExecutionMode) Initializes a new instance of the WebView class with the specified execution mode.

 

Events

The WebView class has these events.

EventDescription
AccessKeyDisplayDismissed Occurs when the access key sequence is complete to notify controls that they should hide access key visuals. (Inherited from UIElement)
AccessKeyDisplayRequested Occurs when the access key sequence is started to notify controls that they should show access key visuals. (Inherited from UIElement)
AccessKeyInvoked Occurs when a user completes an access key sequence to notify the element that the access key action should be invoked. (Inherited from UIElement)
ContainsFullScreenElementChanged Occurs when the status of whether the WebView currently contains a full screen element or not changes.
ContentLoading Occurs when the WebView has started loading new content.
ContextCanceled Occurs when a context input gesture continues into a manipulation gesture, to notify the element that the context flyout should not be opened. (Inherited from UIElement)
ContextRequested Occurs when the user has completed a context input gesture, such as a right-click. (Inherited from UIElement)
DataContextChanged Occurs when the value of the FrameworkElement.DataContext property changes. (Inherited from FrameworkElement)
DOMContentLoaded Occurs when the WebView has finished parsing the current HTML content.
DoubleTapped (not supported; see Remarks) Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element. (Inherited from UIElement)
DragEnter (not supported; see Remarks) Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement)
DragLeave (not supported; see Remarks) Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement)
DragOver (not supported; see Remarks) Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement)
Drop (not supported; see Remarks) Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement)
FrameContentLoading Occurs when a frame in the WebView has started loading new content.
FrameDOMContentLoaded Occurs when a frame in the WebView has finished parsing its current HTML content.
FrameNavigationCompleted Occurs when a frame in the WebView has finished loading its content.
FrameNavigationStarting Occurs before a frame in the WebView navigates to new content.
GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement)
Holding (not supported; see Remarks) Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element. (Inherited from UIElement)
KeyDown (not supported; see Remarks) Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement)
KeyUp (not supported; see Remarks) Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement)
LayoutUpdated Occurs when the layout of the visual tree changes, due to layout-relevant properties changing value or some other action that refreshes the layout. (Inherited from FrameworkElement)
LoadCompleted Occurs when top-level navigation completes and the content loads into the WebView control or when an error occurs during loading.
Loaded Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction. (Inherited from FrameworkElement)
Loading Occurs when a FrameworkElement begins to load. (Inherited from FrameworkElement)
LongRunningScriptDetected Occurs periodically while the WebView executes JavaScript, letting you halt the script.
LostFocus Occurs when a UIElement loses focus. (Inherited from UIElement)
ManipulationCompleted (not supported; see Remarks) Occurs when a manipulation on the UIElement is complete. (Inherited from UIElement)
ManipulationDelta (not supported; see Remarks) Occurs when the input device changes position during a manipulation. (Inherited from UIElement)
ManipulationInertiaStarting (not supported; see Remarks) Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins. (Inherited from UIElement)
ManipulationStarted (not supported; see Remarks) Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement)
ManipulationStarting (not supported; see Remarks) Occurs when the manipulation processor is first created. (Inherited from UIElement)
NavigationCompleted Occurs when the WebView has finished loading the current content or if navigation has failed.
NavigationFailed Occurs when the WebView cannot complete the navigation attempt.
NavigationStarting Occurs before the WebView navigates to new content.
NewWindowRequested Occurs when a user performs an action in a WebView that causes content to be opened in a new window.
PermissionRequested Occurs when an action in a WebView requires that permission be granted.
PointerCanceled (not supported; see Remarks) Occurs when a pointer that made contact abnormally loses contact. (Inherited from UIElement)
PointerCaptureLost (not supported; see Remarks) Occurs when pointer capture previously held by this element moves to another element or elsewhere. (Inherited from UIElement)
PointerEntered (not supported; see Remarks) Occurs when a pointer enters the hit test area of this element. (Inherited from UIElement)
PointerExited (not supported; see Remarks) Occurs when a pointer leaves the hit test area of this element. (Inherited from UIElement)
PointerMoved (not supported; see Remarks) Occurs when a pointer moves while the pointer remains within the hit test area of this element. (Inherited from UIElement)
PointerPressed (not supported; see Remarks) Occurs when the pointer device initiates a Press action within this element. (Inherited from UIElement)
PointerReleased (not supported; see Remarks) Occurs when the pointer device that previously initiated a Press action is released, while within this element. (Inherited from UIElement)
PointerWheelChanged (not supported; see Remarks) Occurs when the delta value of a pointer wheel changes. (Inherited from UIElement)
RightTapped (not supported; see Remarks) Occurs when a right-tap input stimulus happens while the pointer is over the element. (Inherited from UIElement)
ScriptNotify Occurs when the content contained in the WebView control passes a string to the application by using JavaScript.
SizeChanged Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement. (Inherited from FrameworkElement)
Tapped (not supported; see Remarks) Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element. (Inherited from UIElement)
Unloaded Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement)
UnsafeContentWarningDisplaying Occurs when the WebView shows a warning page for content that was reported as unsafe by SmartScreen Filter.
UnsupportedUriSchemeIdentified Occurs when an attempt is made to navigate to a Uniform Resource Identifier (URI) using a scheme that WebView doesn't support.
UnviewableContentIdentified Occurs when the WebView attempts to download an unsupported file.

 

Methods

The WebView class has these methods. It also inherits methods from the Object class.

MethodDescription
AddHandler Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere. (Inherited from UIElement)
AddWebAllowedObject Adds a native Windows Runtime object as a global parameter to the top level document inside of a WebView.
Arrange Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement)
ArrangeOverride Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement)
BuildLocalStreamUri Creates a URI that you can pass to NavigateToLocalStreamUri.
CancelDirectManipulations Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement. (Inherited from UIElement)
CapturePointer Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events. (Inherited from UIElement)
CapturePreviewToStreamAsync Creates an image of the current WebView contents and writes it to the specified stream.
CaptureSelectedContentToDataPackageAsync Asynchronously gets a DataPackage that contains the selected content within the WebView.
ClearTemporaryWebDataAsync Clears the WebView's cache and IndexedDB data.
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject)
DeferredPermissionRequestById Returns the deferred permission request with the specified Id.
FindName Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement)
FindSubElementsForTouchTargeting Enables a UIElement subclass to expose child elements that assist with resolving touch targeting. (Inherited from UIElement)
Focus Sets the input focus to the WebView.
GetAnimationBaseValue Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetBindingExpression Returns the BindingExpression that represents the binding on the specified property. (Inherited from FrameworkElement)
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
GoBack Navigates the WebView to the previous page in the navigation history.
GoForward Navigates the WebView to the next page in the navigation history.
GoToElementStateCore When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup. (Inherited from FrameworkElement)
InvalidateArrange Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement)
InvalidateMeasure Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement)
InvokeScript Executes the specified script function from the currently loaded HTML, with specific arguments.
InvokeScriptAsync As an asynchronous action, executes the specified script function from the currently loaded HTML, with specific arguments.
Measure Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement)
MeasureOverride Provides the behavior for the Measure pass of the layout cycle. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement)
Navigate Loads the HTML content at the specified Uniform Resource Identifier (URI).
NavigateToLocalStreamUri Loads local web content at the specified URI using an IUriToStreamResolver.
NavigateToString Loads the specified HTML content as a new document.
NavigateWithHttpRequestMessage Navigates the WebView to a URI with a POST request and HTTP headers.
OnApplyTemplate Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class. (Inherited from FrameworkElement)
OnCreateAutomationPeer When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure. (Inherited from UIElement)
OnDisconnectVisualChildren Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property. (Inherited from UIElement)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
Refresh Reloads the current content in the WebView.
RegisterPropertyChangedCallback Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject)
ReleasePointerCapture Releases pointer captures for capture of one specific pointer by this UIElement. (Inherited from UIElement)
ReleasePointerCaptures Releases all pointer captures held by this element. (Inherited from UIElement)
RemoveHandler Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler. (Inherited from UIElement)
SetBinding Attaches a binding to a FrameworkElement, using the provided binding object. (Inherited from FrameworkElement)
SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
Stop Halts the current WebView navigation or download.
TransformToVisual Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement)
UnregisterPropertyChangedCallback Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)
UpdateLayout Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement)

 

Properties

The WebView class has these properties.

PropertyAccess typeDescription

AccessKey

Read/write

Gets or sets the access key (mnemonic) for this element. (Inherited from UIElement)

AccessKeyScopeOwner

Read/write

Gets or sets a source element that provides the access key scope for this element, even if it's not in the visual tree of the source element. (Inherited from UIElement)

ActualHeight

Read-only

Gets the rendered height of a FrameworkElement. See Remarks. (Inherited from FrameworkElement)

ActualWidth

Read-only

Gets the rendered width of a FrameworkElement. See Remarks. (Inherited from FrameworkElement)

AllowDrop

Read/write

Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement)

AllowedScriptNotifyUris

Read/write

Gets or sets a safe list of URIs that are permitted to fire ScriptNotify events to this WebView.

AllowedScriptNotifyUrisProperty

Read-only

Identifies the AllowedScriptNotifyUris dependency property.

AllowFocusOnInteraction

Read/write

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it. (Inherited from FrameworkElement)

AllowFocusWhenDisabled

Read/write

Gets or sets whether a disabled control can receive focus. (Inherited from FrameworkElement)

AnyScriptNotifyUri

Read-only

Gets a value that you can use to set the AllowedScriptNotifyUris property to indicate that any page can fire ScriptNotify events to this WebView.

BaseUri

Read-only

Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time. (Inherited from FrameworkElement)

CacheMode

Read/write

Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement)

CanGoBack

Read-only

Gets a value that indicates whether there is at least one page in the backward navigation history.

CanGoBackProperty

Read-only

Identifies the CanGoBack dependency property.

CanGoForward

Read-only

Gets a value that indicates whether there is at least one page in the forward navigation history.

CanGoForwardProperty

Read-only

Identifies the CanGoForward dependency property.

Clip

Read/write

Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement)

CompositeMode

Read/write

Gets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI. (Inherited from UIElement)

ContainsFullScreenElement

Read-only

Gets a value that indicates whether the WebView contains an element that supports full screen.

ContainsFullScreenElementProperty

Read-only

Identifies the ContainsFullScreenElement dependency property.

ContextFlyout

Read/write

Gets or sets the flyout associated with this element. (Inherited from UIElement)

DataContext

Read/write

Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement)

DataTransferPackage

Read-only

Gets a clipboard DataPackage as passed to the WebView.

DataTransferPackageProperty

Read-only

Identifies the DataTransferPackage dependency property.

DefaultBackgroundColor

Read/write

Gets or sets the color to use as the WebView background when the HTML content does not specify a color.

DefaultBackgroundColorProperty

Read-only

Identifies the DefaultBackgroundColor dependency property.

DefaultExecutionMode

Read-only

Gets the default threading behavior of WebView instances in the current app.

DeferredPermissionRequests

Read-only

Gets a collection of permission requests that are waiting to be granted or denied.

DesiredSize

Read-only

Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement)

Dispatcher

Read-only

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject)

DocumentTitle

Read-only

Gets the title of the page currently displayed in the WebView.

DocumentTitleProperty

Read-only

Identifies the DocumentTitle dependency property.

ExecutionMode

Read-only

Gets a value that indicates whether the WebView hosts content on the UI thread or a non-UI thread.

ExitDisplayModeOnAccessKeyInvoked

Read/write

Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked. (Inherited from UIElement)

FlowDirection

Read/write

Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left. (Inherited from FrameworkElement)

FocusVisualMargin

Read/write

Gets or sets the outer margin of the focus visual for a FrameworkElement. (Inherited from FrameworkElement)

FocusVisualPrimaryBrush

Read/write

Gets or sets the brush used to draw the outer border of a HighVisibility focus visual for a FrameworkElement. (Inherited from FrameworkElement)

FocusVisualPrimaryThickness

Read/write

Gets or sets the thickness of the outer border of a HighVisibility focus visual for a FrameworkElement. (Inherited from FrameworkElement)

FocusVisualSecondaryBrush

Read/write

Gets or sets the brush used to draw the inner border of a HighVisibility focus visual for a FrameworkElement. (Inherited from FrameworkElement)

FocusVisualSecondaryThickness

Read/write

Gets or sets the thickness of the inner border of a HighVisibility focus visual for a FrameworkElement. (Inherited from FrameworkElement)

Height

Read/write

Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement)

HorizontalAlignment

Read/write

Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement)

IsAccessKeyScope

Read/write

Gets or sets a value that indicates whether an element defines its own access key scope. (Inherited from UIElement)

IsDoubleTapEnabled

Read/write

Gets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement)

IsHitTestVisible

Read/write

Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement)

IsHoldingEnabled

Read/write

Gets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement)

IsRightTapEnabled

Read/write

Gets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement)

IsTapEnabled

Read/write

Gets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement)

Language

Read/write

Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI. (Inherited from FrameworkElement)

ManipulationMode

Read/write

Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code. (Inherited from UIElement)

Margin

Read/write

Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement)

MaxHeight

Read/write

Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MaxWidth

Read/write

Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinHeight

Read/write

Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinWidth

Read/write

Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

Name

Read/write

Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement)

Opacity

Read/write

Gets or sets the degree of the object's opacity. (Inherited from UIElement)

Parent

Read-only

Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement)

PointerCaptures

Read-only

Gets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement)

Projection

Read/write

Gets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement)

RenderSize

Read-only

Gets the final render size of a UIElement. (Inherited from UIElement)

RenderTransform

Read/write

Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement)

RenderTransformOrigin

Read/write

Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement)

RequestedTheme

Read/write

Gets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme. (Inherited from FrameworkElement)

Resources

Read/write

Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement)

Settings

Read-only

Gets a WebViewSettings object that contains properties to enable or disable WebView features.

Source

Read/write

Gets or sets the Uniform Resource Identifier (URI) source of the HTML content to display in the WebView control.

SourceProperty

Read-only

Identifies the Source dependency property.

Style

Read/write

Gets or sets an instance Style that is applied for this object during layout and rendering. (Inherited from FrameworkElement)

Tag

Read/write

Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement)

Transitions

Read/write

Gets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement)

Triggers

Read-only

Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. (Inherited from FrameworkElement)

UseLayoutRounding

Read/write

Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement)

VerticalAlignment

Read/write

Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement)

Visibility

Read/write

Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout. (Inherited from UIElement)

Width

Read/write

Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement)

XYFocusDown

Read/write

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) down.

XYFocusDownProperty

Read-only

Identifies the XYFocusDown dependency property.

XYFocusLeft

Read/write

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) left.

XYFocusLeftProperty

Read-only

Identifies the XYFocusLeft dependency property.

XYFocusRight

Read/write

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) right.

XYFocusRightProperty

Read-only

Identifies the XYFocusRight dependency property.

XYFocusUp

Read/write

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) up.

XYFocusUpProperty

Read-only

Identifies the XYFocusUp dependency property.

 

Remarks

Use the WebView control to host web content in your app.

WebView is not a Control subclass and thus does not have a control template. You can set various properties to control some visual aspects of the WebView. The display area is constrained by the Width and Height properties. To translate, scale, skew, and rotate a WebView, use the RenderTransform property. To control the opacity of the WebView, set the Opacity property. To specify a color to use as the web page background when the HTML content does not specify a color, set the DefaultBackgroundColor property.

You can get the title of the HTML document currently displayed in the WebView by using the DocumentTitle property.

Although WebView is not a Control subclass, it will receive keyboard input focus and participate in the tab sequence. It provides a Focus method, and GotFocus and LostFocus events, but it has no tab-related properties. Its position in the tab sequence is the same as its position in the XAML document order. The tab sequence includes all elements in the WebView content that can receive input focus.

As indicated in the Events table, WebView doesn’t support most of the user input events inherited from UIElement, such as KeyDown, KeyUp, and PointerPressed. A common workaround is to use InvokeScriptAsync with the JavaScript eval function to use the HTML event handlers, and to use window.external.notify from the HTML event handler to notify the application using WebView.ScriptNotify.

In apps compiled for Windows 10, WebView uses the Microsoft Edge rendering engine to display HTML content. In apps compiled for Windows 8 or Windows 8.1, WebView uses Internet Explorer 11 in document mode. It does not support any ActiveX controls or plugins like Microsoft Silverlight or Portable Document Format (PDF) files.

Navigating to content

WebView provides several APIs for basic navigation: GoBack, GoForward, Stop, Refresh, CanGoBack, and CanGoForward. You can use these to add typical web browsing capabilities to your app.

To set the initial content of the WebView, set the Source property in XAML. The XAML parser automatically converts the string to a Uri.



<!-- Source file is on the web. -->
<WebView x:Name="webView1" Source="http://www.contoso.com"/>

<!-- Source file is in local storage. -->
<WebView x:Name="webView2" Source="ms-appdata:///local/intro/welcome.html"/>

<!-- Source file is in the app package. -->
<WebView x:Name="webView3" Source="ms-appx-web:///help/about.html"/>


The Source property can be set in code, but rather than doing so, you typically use one of the Navigate methods to load content in code.

To load web content, use the Navigate method with a Uri that uses the http or https scheme.


webView1.Navigate("http://www.contoso.com");

To navigate to a URI with a POST request and HTTP headers, use the NavigateWithHttpRequestMessage method. This method supports only HttpMethod.Post and HttpMethod.Get for the HttpRequestMessage.Method property value.

To load uncompressed and unencrypted content from your app’s LocalFolder or TemporaryFolder data stores, use the Navigate method with a Uri that uses the ms-appdata scheme. The WebView support for this scheme requires you to place your content in a subfolder under the local or temporary folder. This enables navigation to URIs such as ms-appdata:///local/folder/file.html and ms-appdata:///temp/folder/file.html . (To load compressed or encrypted files, see NavigateToLocalStreamUri.)

Each of these first-level subfolders is isolated from the content in other first-level subfolders. For example, you can navigate to ms-appdata:///temp/folder1/file.html, but you can’t have a link in this file to ms-appdata:///temp/folder2/file.html. However, you can still link to HTML content in the app package using the ms-appx-web scheme, and to web content using the http and https URI schemes.


webView1.Navigate("ms-appdata:///local/intro/welcome.html");

To load content from the your app package, use the Navigate method with a Uri that uses the ms-appx-web scheme.


webView1.Navigate("ms-appx-web:///help/about.html");

You can load local content through a custom resolver using the NavigateToLocalStreamUri method. This enables advanced scenarios such as downloading and caching web-based content for offline use, or extracting content from a compressed file.

Responding to navigation events

WebView provides several events that you can use to respond to navigation and content loading states. The events occur in the following order for the root WebView content:

  • NavigationStarting- Occurs before the WebView navigates to new content. You can cancel navigation in a handler for this event by setting the WebViewNavigationStartingEventArgs.Cancel property to true.
    
    webView1.NavigationStarting += webView1_NavigationStarting;
    
    private void webView1_NavigationStarting(object sender, WebViewNavigationStartingEventArgs args)
    {
        // Cancel navigation if URL is not allowed. (Implemetation of IsAllowedUri not shown.)
        if (!IsAllowedUri(args.Uri))
            args.Cancel = true;
    }
    
    
    
  • ContentLoading - Occurs when the WebView has started loading new content.
    
    webView1.ContentLoading += webView1_ContentLoading;
    
    private void webView1_ContentLoading(WebView sender, WebViewContentLoadingEventArgs args)
    {
        // Show status.
        if (args.Uri != null)
        {
            statusTextBlock.Text = "Loading content for " + args.Uri.ToString();
        }
    }
    
    
    
  • DOMContentLoaded - Occurs when the WebView has finished parsing the current HTML content.
    
    webView1.DOMContentLoaded += webView1_DOMContentLoaded;
    
    private void webView1_DOMContentLoaded(WebView sender, WebViewDOMContentLoadedEventArgs args)
    {
        // Show status.
        if (args.Uri != null)
        {
            statusTextBlock.Text = "Content for " + args.Uri.ToString() + " has finished loading";
        }
    }
    
    
    
  • NavigationCompleted - Occurs when the WebView has finished loading the current content or if navigation has failed. To determine whether navigation has failed, check the IsSuccess and WebErrorStatus properties of the WebViewNavigationCompletedEventArgs class.
    
    webView1.NavigationCompleted += webView1_NavigationCompleted;
    
    private void webView1_NavigationCompleted(WebView sender, WebViewNavigationCompletedEventArgs args)
    {
        if (args.IsSuccess == true)
        {
            statusTextBlock.Text = "Navigation to " + args.Uri.ToString() + " completed successfully.";
        }
        else
        {
            statusTextBlock.Text = "Navigation to: " + args.Uri.ToString() + 
                                   " failed with error " + args.WebErrorStatus.ToString();
        }
    }
    
    
    

Similar events occur in the same order for each iframe in the WebView content:

Responding to potential problems

You can respond to potential problems with the content such as long running scripts, content that WebView can't load, and warnings of unsafe content.

Your app might appear unresponsive while scripts are running. The LongRunningScriptDetected event occurs periodically while the WebView executes JavaScript and provides an opportunity to interrupt the script. To determine how long the script has been running, check the ExecutionTime property of the WebViewLongRunningScriptDetectedEventArgs. To halt the script, set the event args StopPageScriptExecution property to true. The halted script will not execute again unless it is reloaded during a subsequent WebView navigation.

The WebView control cannot host arbitrary file types. When an attempt is made to load content that the WebView can't host, the UnviewableContentIdentified event occurs. You can handle this event and notify the user, or use the Launcher class to redirect the file to an external browser or another app.

Similarly, the UnsupportedUriSchemeIdentified event occurs when a URI scheme that's not supported is invoked in the web content, such as fbconnect:// or mailto://. You can handle this event to provide custom behavior instead of allowing the default system launcher to launch the URI.

The UnsafeContentWarningDisplayingevent occurs when the WebView shows a warning page for content that was reported as unsafe by the SmartScreen Filter. If the user chooses to continue the navigation, subsequent navigation to the page will not display the warning nor fire the event.

Handling special cases for WebView content

You can use the ContainsFullScreenElement property and ContainsFullScreenElementChanged event to detect, respond to, and enable full-screen experiences in web content, such as full-screen video playback. For example, you may use the ContainsFullScreenElementChanged event to resize the WebView to occupy the entirety of your app view, or, as the following example illustrates, put a windowed app in full screen mode when a full screen web experience is desired.



// Assume webView is defined in XAML
webView.ContainsFullScreenElementChanged += webView_ContainsFullScreenElementChanged;

private void webView_ContainsFullScreenElementChanged(WebView sender, object args)
{
    var applicationView = ApplicationView.GetForCurrentView();

    if (sender.ContainsFullScreenElement)
    {
        applicationView.TryEnterFullScreenMode();
    }
    else if (applicationView.IsFullScreenMode)
    {
        applicationView.ExitFullScreenMode();
    }
}


You can use the NewWindowRequested event to handle cases where hosted web content requests a new window to be displayed, such as a popup window. You can use another WebView control to display the contents of the requested window.

Use PermissionRequested event to enable web features that require special capabilities. These currently include geolocation, IndexedDB storage, and user audio and video (for example, from a microphone or webcam). If your app accesses user location or user media, you still are required to declare this capability in the app manifest. For example, an app that uses geolocation needs the following capability declarations at minimum in Package.appxmanifest:


  <Capabilities>
    <Capability Name="internetClient"/>
    <DeviceCapability Name="location"/>
  </Capabilities>


In addition to the app handling the PermissionRequested event, the user will have to approve standard system dialogs for apps requesting location or media capabilities in order for these features to be enabled.

Here is an example of how an app would enable geolocation in a map from Bing:



// Assume webView is defined in XAML
webView.PermissionRequested += webView_PermissionRequested;

private void webView_PermissionRequested(WebView sender, WebViewPermissionRequestedEventArgs args)
{
    if (args.PermissionRequest.PermissionType == WebViewPermissionType.Geolocation &&
        args.PermissionRequest.Uri.Host == "www.bing.com")
    {
        args.PermissionRequest.Allow();
    }
}


If your app requires user input or other asynchronous operations to respond to a permission request, use the Defer method of WebViewPermissionRequest to create a WebViewDeferredPermissionRequest that can be acted upon at a later time. See WebViewPermissionRequest.Defer.

If users must securely log out of a website hosted in WebView, or in other cases when security is important, call the static method ClearTemporaryWebDataAsync to clear out all locally cached content from a WebView session. This prevents malicious users from accessing sensitive data.

Interacting with WebView content

You can interact with the content of the WebView by using the InvokeScriptAsync method to invoke or inject script into the WebView content, and the ScriptNotify event to get information back from the WebView content.

To invoke JavaScript inside the WebView content, use the InvokeScriptAsync method. The invoked script can return only string values.

For example, if the content of a WebView named webView1 contains a function named setDate that takes 3 parameters, you can invoke it like this.



string[] args = {"January", "1", "2000"};
string returnValue = await webView1.InvokeScriptAsync("setDate", args);

You can use InvokeScriptAsync with the JavaScript eval function to inject content into the web page.

Here, the text of a XAML TextBox (nameTextBox.Text) is written to a div in an HTML page hosted in webView1.



private async void Button_Click(object sender, RoutedEventArgs e)
{
    string functionString = String.Format("document.getElementById('nameDiv').innerText = 'Hello, {0}';", nameTextBox.Text);
    await webView1.InvokeScriptAsync("eval", new string[] { functionString });
}

Scripts in the WebView content can use window.external.notify with a string parameter to send information back to your app. To receive these messages, handle the ScriptNotify event.

To enable an external web page to fire the ScriptNotify event when calling window.external.notify, you must include the page's URI in the ApplicationContentUriRules section of the app manifest. (You can do this in Microsoft Visual Studio on the Content URIs tab of the Package.appxmanifest designer.) The URIs in this list must use HTTPS, and may contain subdomain wildcards (for example, https://*.microsoft.com) but they cannot contain domain wildcards (for example, https://*.com and https://*.*). The manifest requirement does not apply to content that originates from the app package, uses an ms-local-stream:// URI, or is loaded using NavigateToString.

Accessing the Windows Runtime in WebView

Starting in Windows 10, you can use the AddWebAllowedObject method to inject an instance of a native class from a Windows Runtime component into the JavaScript context of the WebView. This allows full access to the native methods, properties, and events of that object in the JavaScript content of that WebView. The class must be decorated with the AllowForWeb attribute.

For example, this code injects an instance of MyClass imported from a Windows Runtime component into WebView.



private void webView_NavigationStarting(WebView sender, WebViewNavigationStartingEventArgs args) 
{ 
    if (args.Uri.Host == "www.contoso.com")  
    { 
        webView.AddWebAllowedObject("nativeObject", new MyClass()); 
    } 
}


For more info, see WebView.AddWebAllowedObject.

In addition, trusted JavaScript content in WebView can be allowed to directly access Windows RuntimeAPIs. This provides powerful native capabilities for web apps hosted in WebView. To enable this feature, the URI for trusted content must be whitelisted in the ApplicationContentUriRules of the app in Package.appxmanifest, with WindowsRuntimeAccess specifically set to "all".

This example shows a section of the app manifest. Here, a local URI is given access to the Windows Runtime.


  <Applications>
    <Application Id="App"
      ...

      <uap:ApplicationContentUriRules>
        <uap:Rule Match="ms-appx-web:///Web/App.html" WindowsRuntimeAccess="all" Type="include"/>
      </uap:ApplicationContentUriRules>
    </Application>
  </Applications>


Options for web content hosting

Starting in Windows 10, you can use the WebView.Settings property (of type WebViewSettings) to control whether JavaScript and IndexedDB are enabled. For example, if you use WebView to display strictly static content, you might want to disable JavaScript for best performance.

Capturing WebView content

To enable sharing WebView content with other apps, use the CaptureSelectedContentToDataPackageAsync method, which returns the selected content as a DataPackage. This method is asynchronous, so you must use a deferral to prevent your DataRequested event handler from returning before the asynchronous call is complete.

To get a preview image of the WebView's current content, use the CapturePreviewToStreamAsync method. This method creates an image of the current content and writes it to the specified stream.

Threading behavior

By default, WebView content is hosted on the UI thread on devices in the desktop device family, and off the UI thread on all other devices. You can use the WebView.DefaultExecutionMode static property to query the default threading behavior for the current client. If necessary, you can use the WebView(WebViewExecutionMode) constructor to override this behavior.

Note  There might be performance issues when hosting content on the UI thread on mobile devices, so be sure to test on all target devices when you change DefaultExecutionMode.
 

A WebView that hosts content off the UI thread is not compatible with parent controls that require gestures to propagate up from the WebView control to the parent, such as FlipView, ScrollViewer, and other related controls. These controls will not be able to receive gestures initiated in the off-thread WebView. In addition, printing off-thread web content is not directly supported – you should print an element with WebViewBrush fill instead.

Notes for previous versions

Windows 8.1

The following WebView APIs are deprecated in Windows 8.1:

On Windows only, you can handle the UnsafeContentWarningDisplaying event. This event occurs when the WebView shows a warning page for content that was reported as unsafe by the SmartScreen Filter. If the user chooses to continue the navigation, subsequent navigation to the page will not display the warning nor fire the event. This event is not implemented for Windows Phone.

When you invoke JavaScript inside the WebView by calling the InvokeScriptAsync method, functions that require a secondary window, like Alert, are not supported.

Windows Phone 8.1

The UnsafeContentWarningDisplaying event is not implemented for Windows Phone prior to Windows 10.

Windows 8

These remarks apply only to apps compiled for Windows 8, even when running on Windows 8.1 or later.

In Windows 8,WebView has the characteristic that other UI regions such as controls cannot be rendered on top of the WebView. This "airspace problem" is because of how window regions are handled internally, particularly how input events are processed and how the screen draws. If you want to render HTML content and also place other UI elements on top of that HTML content, you should use WebViewBrush as the render area. The WebView still provides the HTML source information, and you reference that WebView through the SourceName property. WebViewBrush does not have this overlay limitation.

If you want to display an interactive WebView that only occasionally has overlapping content (such as a drop-down list or app bar), you can temporarily hide the WebView control when necessary, replacing it with an element using a WebViewBrush fill. Then, when the overlapping content is no longer present, you can display the original WebView again.

Note  The "airspace problem" has been fixed starting with Windows 8.1 and does not apply for apps targeting Windows 8.1 or Windows 10.
 

WebView always uses Internet Explorer 10 in document mode.

Examples

The following code example demonstrates how to navigate a WebView to a URI contained in a TextBox named Address.


try
{
    Uri targetUri = new Uri(Address.Text);
    webView1.Navigate(targetUri);
}
catch (FormatException ex)
{
    // Bad address.
}


The following code example demonstrates how to load local HTML into a WebView control.


webView2.NavigateToString(
    "<html><body><h2>This is an HTML fragment</h2></body></html>");

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.UI.Xaml.Controls
Windows::UI::Xaml::Controls [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Controls
Windows::UI::Xaml::Controls [C++]

Metadata

Windows.winmd

Attributes

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]
[WebHostHidden()]

See also

Object
FrameworkElement
XAML WebView control sample

 

 

Show:
© 2016 Microsoft