[This documentation is preliminary and is subject to change.]
Provides a UI element that hosts HTML content within the application.
Inheritance
Syntax
public sealed class WebView : FrameworkElement, IDependencyObject, IUIElement, IUIElementOverrides, IFrameworkElement, IFrameworkElementOverrides, IWebView
<WebView .../>
Attributes
- ActivatableAttribute(0x6020000)
- StaticAttribute(Windows.UI.Xaml.Controls.IWebViewStatics, 100794368)
- VersionAttribute(100794368)
- WebHostHiddenAttribute()
Members
The WebView class has the following types of members:
Constructors
The WebView class has the following constructors.
| Constructor | Description |
|---|---|
| WebView | Initializes a new instance of the WebView class. |
Events
The WebView class has the following events.
| Event | Description |
|---|---|
| DoubleTapped | Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element.(Inherited from UIElement) |
| DragEnter | Occurs when the input system reports an underlying drag event with this element as the target.(Inherited from UIElement) |
| DragLeave | Occurs when the input system reports an underlying drag event with this element as the origin.(Inherited from UIElement) |
| DragOver | Occurs when the input system reports an underlying drag event with this element as the potential drop target.(Inherited from UIElement) |
| Drop | Occurs when the input system reports an underlying drop event with this element as the drop target.(Inherited from UIElement) |
| GotFocus | Occurs when a UIElement receives focus.(Inherited from UIElement) |
| Holding | Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element.(Inherited from UIElement) |
| 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 visual tree changes.(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.(Inherited from FrameworkElement) |
| LostFocus | Occurs when a UIElement loses focus.(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) |
| ManipulationInertiaStarting | Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins.(Inherited from UIElement) |
| ManipulationStarted | Occurs when an input device begins a manipulation on the UIElement.(Inherited from UIElement) |
| ManipulationStarting | Occurs when the manipulation processor is first created.(Inherited from UIElement) |
| PointerCanceled | Occurs when a pointer that made contact abnormally loses contact.(Inherited from UIElement) |
| PointerCaptureLost | Occurs when pointer capture previously held by this element moves to another element or elsewhere.(Inherited from UIElement) |
| PointerEntered | Occurs when a pointer enters the hit test area of this element.(Inherited from UIElement) |
| PointerExited | Occurs when a pointer leaves the hit test area of this element.(Inherited from UIElement) |
| PointerMoved | Occurs when a pointer moves while the pointer remains within the hit test area of this element.(Inherited from UIElement) |
| PointerPressed | Occurs when the pointer device initiates a Press action within this element.(Inherited from UIElement) |
| PointerReleased | Occurs when the pointer device that previously initiated a Press action is released, while within this element.(Inherited from UIElement) |
| PointerWheelChanged | Occurs when the delta value of a pointer wheel changes.(Inherited from UIElement) |
| RightTapped | 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 properties change value on a FrameworkElement.(Inherited from FrameworkElement) |
| Tapped | 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) |
Methods
The WebView class has the following methods.
| Method | Description |
|---|---|
| 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) |
| CapturePointer | Sets pointer capture to a UIElement. (Inherited from UIElement) |
| ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject) |
| Equals | 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 it is reclaimed by garbage collection. (Inherited from Object) |
| FindName | Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement) |
| GetAnimationBaseValue | Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object) |
| 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) |
| 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 | |
| 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) |
| MemberwiseClone | Creates a shallow copy of the current object. (Inherited from Object) |
| Navigate | Loads the HTML content at the specified URI. |
| NavigateToString | Displays the specified HTML content. |
| 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 an application. (Inherited from FrameworkElement) |
| OnApplyTemplateCore | Infrastructure for OnApplyTemplate. (Inherited from FrameworkElement) |
| OnCreateAutomationPeer | When implemented in a derived class, returns class-specific AutomationPeer implementations for the UI Automation infrastructure. (Inherited from UIElement) |
| ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (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) |
| 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) |
| 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) |
Properties
The WebView class has the following properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets the rendered height of a FrameworkElement. | |
| Read-only | Gets the rendered width of a FrameworkElement. | |
| Read/write | Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. | |
| Read-only | Gets a URI that represents the base URI for an application at XAML load time. This property is used for relative URI resolution as part of how URIs that are specified as relative values in XAML attribute strings can generate legitimate URI values for run time use and resource loading. | |
| Read/write | Gets or sets a value that indicates that rendered content should be cached when possible. | |
| Read/write | Gets or sets the Geometry used to define the outline of the contents of a UIElement. | |
| Read/write | Gets or sets the data context for a FrameworkElement when it participates in data binding. | |
| Read-only | Gets the size that this UIElement computed during the measure pass of the layout process. | |
| Read-only | Gets the CoreDispatcher that this object is associated with. | |
| Read/write | Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. | |
| Read/write | Gets or sets the suggested height of a FrameworkElement. | |
| 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. | |
| Read/write | Gets or sets a value that determines whether the DoubleTapped event can originate from that element. | |
| Read/write | Gets or sets whether the contained area of this UIElement can return true values for hit testing. | |
| Read/write | Gets or sets a value that determines whether the Holding event can originate from that element. | |
| Read/write | Gets or sets a value that determines whether the RightTapped event can originate from that element. | |
| Read/write | Gets or sets a value that determines whether the Tapped event can originate from that element. | |
| Read/write | Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. | |
| Read/write | Gets or sets the outer margin of a FrameworkElement. | |
| Read/write | Gets or sets the maximum height constraint of a FrameworkElement. | |
| Read/write | Gets or sets the maximum width constraint of a FrameworkElement. | |
| Read/write | Gets or sets the minimum height constraint of a FrameworkElement. | |
| Read/write | Gets or sets the minimum width constraint of a FrameworkElement. | |
| 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. | |
| Read/write | Gets or sets the "site of origin", for purposes of restricting scripting access. | |
| Read-only | Identifies the NavigationDomain dependency property. | |
| Read/write | Gets or sets the degree of the object's opacity. | |
| Read-only | Gets the parent object of this FrameworkElement in the object tree. | |
| Read-only | Gets the set of all captured pointers, represented as Pointer values. | |
| Read-only | Gets the final render size of a UIElement. | |
| Read/write | Gets or sets transform information that affects the rendering position of a UIElement. | |
| Read/write | Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. | |
| 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. | |
| Read/write | Gets or sets the URI source of the HTML content to display in the WebView control. | |
| Read-only | Identifies the Source dependency property. | |
| Read/write | Gets or sets an instance Style that is applied for this object during rendering. | |
| Read/write | Gets or sets an arbitrary object value that can be used to store custom information about this object. | |
| Read/write | Gets or sets the collection of Transition style elements that apply to a UIElement. | |
| Read-only | Gets the collection of triggers for animations that are defined for a FrameworkElement. | |
| 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. | |
| 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. | |
| Read/write | 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. | |
| Read/write | Gets or sets the width of a FrameworkElement. |
Remarks
WebView is not a Control subclass and thus does not have a control template. The display area is the Width and Height.
WebView has the characteristic that other UI regions such as controls cannot be rendered on top of the WebView. This 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 element name binding and the SourceName property. WebViewBrush does not have this overlay limitation.
Requirements
|
Minimum supported client | Windows Developer Preview |
|---|---|
|
Minimum supported server | Windows Server Developer Preview |
|
Namespace |
Windows.UI.Xaml.Controls |
|
Assembly |
|
See also
Build date: 9/7/2011
