WebViewBrush WebViewBrush WebViewBrush WebViewBrush Class

Definition

Provides a brush that renders the content that is currently hosted in a WebView control.

public : sealed class WebViewBrush : TileBrush, IWebViewBrush
struct winrt::Windows::UI::Xaml::Controls::WebViewBrush : TileBrush, IWebViewBrush
public sealed class WebViewBrush : TileBrush, IWebViewBrush
Public NotInheritable Class WebViewBrush Inherits TileBrush Implements IWebViewBrush
<WebViewBrush .../>
Inheritance
WebViewBrushWebViewBrushWebViewBrushWebViewBrush
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

The following Windows 8-specific code example demonstrates how to use a WebViewBrush to enable XAML-based content to overlap HTML-based content. In this example, the WebView control is displayed by default so that it remains interactive. When the ComboBox drop-down list is open, however, it overlaps the WebView control. In this case, the WebView is hidden and the WebViewBrush displays the HTML content on a Rectangle occupying the same space.

<Grid x:Name="Output" Grid.Row="1">
    <Grid.RowDefinitions>
        <RowDefinition Height="Auto"/>
        <RowDefinition Height="*"/>
    </Grid.RowDefinitions>
    <ComboBox x:Name="ComboBox1" Height="50" Width="200" HorizontalAlignment="Left" Margin="10,0,0,0">
        <ComboBoxItem>
            <x:String>First Item</x:String>
        </ComboBoxItem>
        <ComboBoxItem>
            <x:String>Second Item</x:String>
        </ComboBoxItem>
        <ComboBoxItem>
            <x:String>Third Item</x:String>
        </ComboBoxItem>
        <ComboBoxItem>
            <x:String>Fourth Item</x:String>
        </ComboBoxItem>
        <ComboBoxItem>
            <x:String>Fifth Item</x:String>
        </ComboBoxItem>
        <ComboBoxItem>
            <x:String>Sixth Item</x:String>
        </ComboBoxItem>
        <ComboBoxItem>
            <x:String>Seventh Item</x:String>
        </ComboBoxItem>
    </ComboBox>
    <Border BorderThickness="1" BorderBrush="#FF707070"  Grid.Row="1" Margin="10,0,0,0">
        <Grid>
            <WebView x:Name="WebView6" />
            <Rectangle x:Name="Rect1"/>
        </Grid>
    </Border>
</Grid>
void SDKSample::WebViewControl::Scenario6::ComboBox1_DropDownOpened(
    Platform::Object^ sender, Platform::Object^ e)
{
    if (Rect1->Visibility == Windows::UI::Xaml::Visibility::Visible)
    {
        WebViewBrush^ b = ref new WebViewBrush();
        b->SourceName = "WebView6";
        b->Redraw();
        Rect1->Fill = b;
        WebView6->Visibility = Windows::UI::Xaml::Visibility::Collapsed;    
    }
}

void SDKSample::WebViewControl::Scenario6::ComboBox1_DropDownClosed(
    Platform::Object^ sender, Platform::Object^ e)
{
    WebView6->Visibility = Windows::UI::Xaml::Visibility::Visible;
    Rect1->Fill = ref new SolidColorBrush(Windows::UI::Colors::Transparent);
}
void ComboBox1_DropDownOpened(object sender, object e)
{
    if (Rect1.Visibility == Windows.UI.Xaml.Visibility.Visible)
    {
        WebViewBrush b = new WebViewBrush();
        b.SourceName = "WebView6";
        b.Redraw();
        Rect1.Fill = b;
        WebView6.Visibility = Windows.UI.Xaml.Visibility.Collapsed;
    }
}

void ComboBox1_DropDownClosed(object sender, object e)
{
    WebView6.Visibility = Windows.UI.Xaml.Visibility.Visible;
    Rect1.Fill = new SolidColorBrush(Windows.UI.Colors.Transparent);
}
Private Sub ComboBox1_DropDownOpened(sender As Object, e As Object)
    If Rect1.Visibility = Windows.UI.Xaml.Visibility.Visible Then
        Dim b As New WebViewBrush()
        b.SourceName = "WebView6"
        b.Redraw()
        Rect1.Fill = b
        WebView6.Visibility = Windows.UI.Xaml.Visibility.Collapsed
    End If
End Sub

Private Sub ComboBox1_DropDownClosed(sender As Object, e As Object)
    WebView6.Visibility = Windows.UI.Xaml.Visibility.Visible
    Rect1.Fill = New SolidColorBrush(Windows.UI.Colors.Transparent)
End Sub

Remarks

In Windows 8, the WebView control has the characteristic that other UI regions such as controls cannot be rendered on top of it. 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 the SourceName property (or by calling SetSource, the method and property yield the same results). WebViewBrush does not have this overlay limitation, but it doesn't enable interaction.

Note

The preceding remarks apply only to apps compiled for Windows 8, even when running on Windows 8.1. Windows 8.1 introduces changes to the WebView control that fix the issues described here. For Windows 8.1, it's anticipated that scenarios where you'll still use a WebViewBrush won't be very common. In most cases you can just use a WebView control and get the functionality you need.

You can apply a WebViewBrush to any property that takes a Brush. For example, you can set Shape.Fill or Control.Background with a WebViewBrush.

There are two alternatives for associating a WebViewBrush with a WebView control source:

Important

It's often necessary to call Redraw for a WebViewBrush that's declared in XAML in the same UI as is the WebView source. A WebView control has an inherently asynchronous behavior that redraws the control when its content is completely loaded. But an associated WebViewBrush renders as soon as the XAML is parsed (which might be before the URI content is loaded by the WebView ). Alternatively, you can wait to call SetSource on the WebViewBrush until the source content is fully loaded (for example by calling SetSource in the handler for the WebView.LoadCompleted event.

This class is not supported on Windows Phone 8.x. WebView content will not be captured.

Constructors

WebViewBrush() WebViewBrush() WebViewBrush() WebViewBrush()

Initializes a new instance of the WebViewBrush class.

public : WebViewBrush()
WebViewBrush() const;
public WebViewBrush()
Public Sub New()

Properties

AlignmentX AlignmentX AlignmentX AlignmentX

Gets or sets the horizontal alignment of content in the TileBrush base tile.

(Inherited from TileBrush)

AlignmentXProperty AlignmentXProperty AlignmentXProperty AlignmentXProperty

Identifies the AlignmentX dependency property.

(Inherited from TileBrush)

AlignmentY AlignmentY AlignmentY AlignmentY

Gets or sets the vertical alignment of content in the TileBrush base tile.

(Inherited from TileBrush)

AlignmentYProperty AlignmentYProperty AlignmentYProperty AlignmentYProperty

Identifies the AlignmentY dependency property.

(Inherited from TileBrush)

Dispatcher Dispatcher Dispatcher Dispatcher

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)

Opacity Opacity Opacity Opacity

Gets or sets the degree of opacity of a Brush.

(Inherited from Brush)

OpacityProperty OpacityProperty OpacityProperty OpacityProperty

Identifies the Opacity dependency property.

(Inherited from Brush)

RelativeTransform RelativeTransform RelativeTransform RelativeTransform

Gets or sets the transformation that is applied to the brush using relative coordinates.

(Inherited from Brush)

RelativeTransformProperty RelativeTransformProperty RelativeTransformProperty RelativeTransformProperty

Identifies the RelativeTransform dependency property.

(Inherited from Brush)

SourceName SourceName SourceName SourceName

Gets or sets the name of the source WebView control that provides the HTML content.

public : Platform::String SourceName { get; set; }
winrt::hstring SourceName(); void SourceName(winrt::hstring sourcename);
public string SourceName { get; set; }
Public ReadWrite Property SourceName As string
<WebViewBrush SourceName="nameOfWebView"/>
Value
string string

The Name or x:Name attribute of the WebView that provides the HTML content.

Remarks

There are two alternatives for associating a WebViewBrush with a WebView control source:

SourceNameProperty SourceNameProperty SourceNameProperty SourceNameProperty

Identifies the SourceName dependency property.

public : static DependencyProperty SourceNameProperty { get; }
static DependencyProperty SourceNameProperty();
public static DependencyProperty SourceNameProperty { get; }
Public Static ReadOnly Property SourceNameProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the SourceName dependency property.

Stretch Stretch Stretch Stretch

Gets or sets a value that specifies how the content of this TileBrush stretches to fit its tiles.

(Inherited from TileBrush)

StretchProperty StretchProperty StretchProperty StretchProperty

Identifies the Stretch dependency property.

(Inherited from TileBrush)

Transform Transform Transform Transform

Gets or sets the transformation that is applied to the brush.

(Inherited from Brush)

TransformProperty TransformProperty TransformProperty TransformProperty

Identifies the Transform dependency property.

(Inherited from Brush)

Methods

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Clears the local value of a dependency property.

(Inherited from DependencyObject)

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Returns any base value established for a dependency property, which would apply in cases where an animation is not active.

(Inherited from DependencyObject)

GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

(Inherited from DependencyObject)

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

(Inherited from DependencyObject)

Redraw() Redraw() Redraw() Redraw()

Causes the WebViewBrush to get updated source pixels from the associated WebView and its current content. This happens asynchronously.

public : void Redraw()
void Redraw() const;
public void Redraw()
Public Function Redraw() As void

Remarks

A WebViewBrush is basically a snapshot of the content being displayed in a WebView. It won't show animations or any dynamic changes to the content. Call Redraw if the source WebView has changed its content significantly and you want to make a new snapshot to display as the WebViewBrush content.

See Also

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

(Inherited from DependencyObject)

SetSource(WebView) SetSource(WebView) SetSource(WebView) SetSource(WebView)

Sets the source of the content for the WebViewBrush.

public : void SetSource(WebView source)
void SetSource(WebView source) const;
public void SetSource(WebView source)
Public Function SetSource(source As WebView) As void
Parameters
source
WebView WebView

The WebView hosting the HTML content that is the source for the brush.

Remarks

There are two alternatives for associating a WebViewBrush with a WebView control source:

SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Sets the local value of a dependency property on a DependencyObject.

(Inherited from DependencyObject)

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

(Inherited from DependencyObject)

See Also