WebView class

Applies to Windows and Windows Phone

Provides a control that hosts HTML content in an app.

Inheritance

Object
  DependencyObject
    UIElement
      FrameworkElement
        WebView

Syntax


public sealed class WebView : FrameworkElement

Attributes

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

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.

 

Events

The WebView class has these events.

EventDescription
ContentLoading Occurs when the WebView has started loading new content.
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)
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.
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.
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)
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.
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject)
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.
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)
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

ActualHeight

Read-onlyGets the rendered height of a FrameworkElement. (Inherited from FrameworkElement)

ActualWidth

Read-onlyGets the rendered width of a FrameworkElement. (Inherited from FrameworkElement)

AllowDrop

Read/writeGets 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/writeGets or sets a safe list of URIs that are permitted to fire ScriptNotify events to this WebView.

AllowedScriptNotifyUrisProperty

Read-onlyIdentifies the AllowedScriptNotifyUris dependency property.

AnyScriptNotifyUri

Read-onlyGets 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-onlyGets 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/writeGets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement)

CanGoBack

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

CanGoBackProperty

Read-onlyIdentifies the CanGoBack dependency property.

CanGoForward

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

CanGoForwardProperty

Read-onlyIdentifies the CanGoForward dependency property.

Clip

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

CompositeMode

Read/writeGets 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)

DataContext

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

DataTransferPackage

Read-onlyGets a clipboard DataPackage as passed to the WebView.

DataTransferPackageProperty

Read-onlyIdentifies the DataTransferPackage dependency property.

DefaultBackgroundColor

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

DefaultBackgroundColorProperty

Read-onlyIdentifies the DefaultBackgroundColor dependency property.

DesiredSize

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

Dispatcher

Read-onlyGets 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-onlyGets the title of the page currently displayed in the WebView.

DocumentTitleProperty

Read-onlyIdentifies the DocumentTitle dependency property.

FlowDirection

Read/writeGets 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)

Height

Read/writeGets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement)

HorizontalAlignment

Read/writeGets 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)

IsDoubleTapEnabled

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

IsHitTestVisible

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

IsHoldingEnabled

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

IsRightTapEnabled

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

IsTapEnabled

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

Language

Read/writeGets 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/writeGets 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/writeGets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement)

MaxHeight

Read/writeGets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MaxWidth

Read/writeGets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinHeight

Read/writeGets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinWidth

Read/writeGets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

Name

Read/writeGets 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/writeGets or sets the degree of the object's opacity. (Inherited from UIElement)

Parent

Read-onlyGets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement)

PointerCaptures

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

Projection

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

RenderSize

Read-onlyGets the final render size of a UIElement. (Inherited from UIElement)

RenderTransform

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

RenderTransformOrigin

Read/writeGets 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/writeGets 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/writeGets 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)

Source

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

SourceProperty

Read-onlyIdentifies the Source dependency property.

Style

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

Tag

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

Transitions

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

Triggers

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

UseLayoutRounding

Read/writeGets 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/writeGets 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/writeGets 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/writeGets or sets the width of a FrameworkElement. (Inherited from FrameworkElement)

 

Remarks

Use the WebView control to host web content in your app. Note that the control behavior has changed starting with Windows 8.1. See below for details.

WebView is not a Control subclass and thus does not have a control template. The display area is constrained by the Width and Height properties.

Although WebView is not a Control subclass, it can 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 to this problem is to use WebView.InvokeScript (InvokeScriptAsync starting in Windows 8.1) with eval to use the HTML event handlers, and to use window.external.notify from the HTML event handler to notify the application using WebView.ScriptNotify.

WebView does not support the ms-appdata scheme, although it does support the ms-appx-web scheme, which you can use to load content files from your app package.

Additionally, WebView does not currently support some HTML5 features including AppCache, IndexedDB, programmatic access to the Clipboard, or geolocation.

Windows 8

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

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.

WebView always uses Internet Explorer 10 in document mode.



<WebView Source="ms-appx-web:///HTMLPage1.html"/>


Windows 8.1

Windows 8.1 introduces changes to the WebView control that fix several issues and add new functionality, including:

WebView always uses Internet Explorer 11 in document mode.

Windows 8.1 deprecates the following WebView APIs:

These changes do not affect apps compiled for Windows 8, even when running on Windows 8.1.

Windows Phone 8.1

  • WebView on Windows Phone 8.1 is not compatible with parent controls that require gestures to propagate up from the WebView control to the parent, such as FlipView, ScrollViewer class, and other related controls.

Examples

The following code example demonstrates how to navigate a WebView to a URI contained in a TextBox named Address. The full code listing for this and the following examples is available in the WebView control sample.


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>");

The following code example demonstrates how to use a WebView control to call a JavaScript function contained in the HTML it has loaded.

Note  Starting in Windows 8.1, you should use InvokeScriptAsync instead of InvokeScript.


string htmlFragment = 
    "<html><head><script type='text/javascript'>function SayGoodbye() { " +
    "document.getElementById('myDiv').innerText = 'GoodBye'; } " +
    "</script></head><body><div id='myDiv'>Hello</div></body></html>";

WebView3.NavigateToString(htmlFragment);

WebView3.DOMContentLoaded += async (s, e) => await WebView3.InvokeScriptAsync("SayGoodbye", null);


Requirements

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

See also

FrameworkElement
XAML WebView control sample

 

 

Show:
© 2014 Microsoft