WebBrowser Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Allows HTML rendering and navigation functionality to be embedded in an application.

Inheritance Hierarchy

System..::.Object
  System.Windows..::.DependencyObject
    System.Windows..::.UIElement
      System.Windows..::.FrameworkElement
        System.Windows.Controls..::.Control
          Microsoft.Phone.Controls..::.WebBrowserBase
            Microsoft.Phone.Controls..::.WebBrowser

Namespace:  Microsoft.Phone.Controls
Assembly:  Microsoft.Phone (in Microsoft.Phone.dll)
XMLNS for XAML: Not mapped to an xmlns.

Syntax

<TemplatePartAttribute(Name := "StateContainer", Type := GetType(Border))> _
<TemplateVisualStateAttribute(Name := "Disabled", GroupName := "WebBrowserStates")> _
<TemplateVisualStateAttribute(Name := "Normal", GroupName := "WebBrowserStates")> _
<TemplatePartAttribute(Name := "PresentationContainer", Type := GetType(Border))> _
Public NotInheritable Class WebBrowser _
    Inherits WebBrowserBase _
    Implements ISupportInitialize
[TemplatePartAttribute(Name = "StateContainer", Type = typeof(Border))]
[TemplateVisualStateAttribute(Name = "Disabled", GroupName = "WebBrowserStates")]
[TemplateVisualStateAttribute(Name = "Normal", GroupName = "WebBrowserStates")]
[TemplatePartAttribute(Name = "PresentationContainer", Type = typeof(Border))]
public sealed class WebBrowser : WebBrowserBase, 
    ISupportInitialize
<WebBrowser .../>

The WebBrowser type exposes the following members.

Constructors

  Name Description
WebBrowser Initializes a new instance of the WebBrowser class.

Top

Properties

  Name Description
ActualHeight Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
ActualWidth Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
AllowDrop 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.)
Background (Inherited from Control.)
Base Sets the base directory within isolated storage that is used to resolve relative references within the WebBrowser control.
BorderBrush (Inherited from Control.)
BorderThickness (Inherited from Control.)
CacheMode Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
CanGoBack Gets a value that indicates whether the WebBrowser can navigate back a page in the browsing history.
CanGoForward Gets a value that indicates whether the WebBrowser can navigate forward a page in the browsing history.
CharacterSpacing (Inherited from Control.)
Clip Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
ContainsFullScreenElement Gets a value that indicates whether the WebBrowser content has entered full screen mode.
Cursor Infrastructure. Gets or sets the cursor image that displays while the pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
DataContext Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
DefaultStyleKey (Inherited from Control.)
DesiredSize Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Dispatcher Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
FlowDirection Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
FontFamily (Inherited from Control.)
FontSize (Inherited from Control.)
FontStretch (Inherited from Control.)
FontStyle (Inherited from Control.)
FontWeight (Inherited from Control.)
Foreground (Inherited from Control.)
Height Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
HorizontalAlignment 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.)
HorizontalContentAlignment (Inherited from Control.)
IsEnabled (Inherited from Control.)
IsGeolocationEnabled Determines whether a website that is hosted in the WebBrowser control can use location services on the device.
IsHitTestVisible Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
IsScriptEnabled Enables or disables scripting. This applies to the next document that is navigated to, not the current document. This property is false by default. Set this property to true to enable scripting, or false to disable scripting.
IsTabStop (Inherited from Control.)
Language Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Margin Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
MaxHeight Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
MaxWidth Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
MinHeight Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
MinWidth Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Name 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 Gets or sets the degree of the object's opacity. (Inherited from UIElement.)
OpacityMask Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Padding (Inherited from Control.)
Parent Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
Projection Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
RenderSize Gets the final render size of a UIElement. (Inherited from UIElement.)
RenderTransform Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
RenderTransformOrigin Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.)
Resources 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.)
Source Gets or sets the URI location of the WebBrowser control.
Style Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
TabIndex (Inherited from Control.)
TabNavigation (Inherited from Control.)
Tag Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Template (Inherited from Control.)
Triggers Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
UseLayoutRounding 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.)
UseOptimizedManipulationRouting Gets or sets a value that indicates whether the system should handle input events or whether the FrameworkElement should handle input events. (Inherited from FrameworkElement.)
VerticalAlignment 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.)
VerticalContentAlignment (Inherited from Control.)
Visibility Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.)
Width Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)

Top

Methods

  Name Description
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 for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.)
ApplyTemplate (Inherited from Control.)
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 Windows Phone layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.)
CaptureMouse Sets touch capture to a UIElement. (Inherited from UIElement.)
CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
FindName Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
Focus (Inherited from Control.)
GetAnimationBaseValue Returns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
GetBindingExpression Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetHostedProvider Gets the hosted provider to pass back to UI Automation core.
GetTemplateChild (Inherited from Control.)
GetType Gets the Type of the current instance. (Inherited from Object.)
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
GoBack Causes the WebBrowser to navigate back a page in the browsing history.
GoForward Causes the WebBrowser to navigate forward a page in the browsing history.
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(String) Executes a scripting function defined in the currently loaded document.
InvokeScript(String, array<String>[]()[]) Executes a scripting function defined in the currently loaded document, and passes the function an array of string parameters.
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 Windows Phone layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Navigate(Uri) Initiates a navigate request to the provided URI.
Navigate(Uri, array<Byte>[]()[], String) Initiates a navigate request to the provided URI. This method allows customizable options for including posted form data and HTTP headers.
NavigateToString Injects an HTML string into the web browser control for rendering.
OnApplyTemplate This API is not intended to be used directly from your code. (Overrides FrameworkElement..::.OnApplyTemplate()()().)
OnCreateAutomationPeer When implemented in a derived class, returns class-specific AutomationPeer implementations for the Windows Phone automation infrastructure. (Inherited from UIElement.)
OnDoubleTap (Inherited from Control.)
OnDragEnter (Inherited from Control.)
OnDragLeave (Inherited from Control.)
OnDragOver (Inherited from Control.)
OnDrop (Inherited from Control.)
OnGotFocus (Inherited from Control.)
OnHold (Inherited from Control.)
OnKeyDown (Inherited from Control.)
OnKeyUp (Inherited from Control.)
OnLostFocus (Inherited from Control.)
OnLostMouseCapture (Inherited from Control.)
OnManipulationCompleted (Inherited from Control.)
OnManipulationDelta (Inherited from Control.)
OnManipulationStarted (Inherited from Control.)
OnMouseEnter (Inherited from Control.)
OnMouseLeave (Inherited from Control.)
OnMouseLeftButtonDown (Inherited from Control.)
OnMouseLeftButtonUp (Inherited from Control.)
OnMouseMove (Inherited from Control.)
OnMouseRightButtonDown (Inherited from Control.)
OnMouseRightButtonUp (Inherited from Control.)
OnMouseWheel (Inherited from Control.)
OnTap (Inherited from Control.)
OnTextInput (Inherited from Control.)
OnTextInputStart (Inherited from Control.)
OnTextInputUpdate (Inherited from Control.)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
ReleaseMouseCapture Removes touch capture from a UIElement. After this call, typically no object holds touch capture. (Inherited from UIElement.)
RemoveHandler Removes the specified routed event handler from this UIElement. (Inherited from UIElement.)
SaveToString Returns a string containing the HTML content of the webpage.
SetBinding Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
ToString Returns a string that represents the current object. (Inherited from Object.)
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.)

Top

Events

  Name Description
BindingValidationError Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
ContainsFullScreenElementChanged Occurs when the fullscreen state of the WebBrowser content is changed.
DoubleTap Occurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement.)
Hold Occurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
IsEnabledChanged (Inherited from Control.)
KeyDown Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
KeyUp Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
LayoutUpdated Occurs when the layout of the Windows Phone visual tree changes. (Inherited from FrameworkElement.)
LoadCompleted Occurs after the WebBrowser control has loaded content.
Loaded Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
LostFocus Occurs when a UIElement loses focus. (Inherited from UIElement.)
LostMouseCapture Occurs when the UIElement loses touch capture. (Inherited from UIElement.)
ManipulationCompleted Occurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
ManipulationDelta Occurs when the input device changes position during a manipulation. (Inherited from UIElement.)
ManipulationStarted Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
MouseEnter Occurs when a screen tap occurs within the bounding area of a UIElement. (Inherited from UIElement.)
MouseLeave Occurs when a touch event occurs outside the bounding area of a UIElement. (Inherited from UIElement.)
MouseLeftButtonDown Occurs when a UIElement is tapped. (Inherited from UIElement.)
MouseLeftButtonUp Occurs when the finger is lifted off of a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
MouseMove Occurs when the coordinate position of the finger on the screen while touching a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
MouseWheel Infrastructure. Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
Navigated Occurs after the WebBrowser control successfully navigates.
Navigating Occurs when the WebBrowser control is navigating, including from a redirect.
NavigationFailed Occurs after the WebBrowser control fails to navigate.
ScriptNotify Occurs when JavaScript calls the window.external.notify(<data>) method.
SizeChanged Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Tap Occurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
TextInput Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
TextInputStart Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
TextInputUpdate Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Unloaded Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)

Top

Extension Methods

  Name Description
ClearCookiesAsync Clears the cookies associated with the specified web browser control asynchronously. (Defined by WebBrowserExtensions.)
ClearInternetCacheAsync Clears the Internet cache associated with the specified web browser control asynchronously. (Defined by WebBrowserExtensions.)
GetCookies Returns a collection of cookies retrieved from the Source URI of the specified WebBrowser control. (Defined by WebBrowserExtensions.)

Top

Fields

  Name Description
BaseProperty Identifies the Base dependency property.
CanGoBackProperty Identifies the CanGoBack dependency property.
CanGoForwardProperty Identifies the CanGoForward dependency property.
ContainsFullScreenElementProperty Identifies the ContainsFullScreenElement dependency property.
IsGeolocationEnabledProperty Identifies the IsGeolocationEnabled dependency property.
IsScriptEnabledProperty Identifies the IsScriptEnabled dependency property.
SourceProperty Identifies the Source dependency property.

Top

Explicit Interface Implementations

  Name Description
ISupportInitialize..::.BeginInit Signals the object that initialization is starting.
ISupportInitialize..::.EndInit Signals the object that initialization is complete.

Top

Remarks

The following illustration shows a WebBrowser embedded in a Windows Phone app.

You can specify the HTML content to display in the WebBrowser control in a number of ways.Call the NavigateToString method and pass a string that contains the HTML content you want to display. Set the Source property to a fully qualified or relative URI. Use the Background property to set the color that displays during page transitions within the control.Call the Navigate method and pass a fully qualified or relative URI for the HTML content you want to display.In addition, you can call scripts in the HTML content by calling InvokeScript method and passing the name of the script you want to execute. You can use the ScriptNotify method of the Window.External object to communicate from JavaScript in the HTML to managed code. ScriptNotify event occurs when this happens.

 Windows Phone OS 7.1: The UserAgent string sent by the WebBrowser control for Windows Phone 8 is slightly different than the UserAgent string sent by the control in Windows Phone OS 7.1 A server-side app developer should not look for an exact match of a UserAgent string, but instead should look for a more general match.

If your Windows Phone OS 7.1 app uses the WebBrowser control, it may not display the same in Windows Phone 8 as it does on Windows Phone OS 7.1. You should deploy and test your app on the Windows Phone 8 Emulator and/or phone. You should look for changes in appearance to the text, bullet items and drop-down arrows in the WebBrowser and determine if these changes affect the usability of your app.

If an app that targets Windows Phone OS 7.1 is deployed to a phone running Windows Phone 8 and that app uses the ScriptNotify method of the Window.External object to call OnContextMenu, the context menu will not show because is not supported in Windows Phone 8. You can show a context menu in Windows Phone 8 by using the OnMSGestureHold event.

Capabilities

If you use this API in your app, you must specify the following capabilities in the app manifest. Otherwise, your app might not work correctly or it might exit unexpectedly.

ID_CAP_WEBBROWSERCOMPONENT

Windows Phone 8, Windows Phone OS 7.1

ID_CAP_NETWORKING

Windows Phone 8, Windows Phone OS 7.1

For more info, see App capabilities and hardware requirements for Windows Phone 8.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Phone.Controls Namespace

Other Resources

WebBrowser control for Windows Phone 8

WebBrowser control design guidelines for Windows Phone

How to use the web browser task for Windows Phone 8