Skip to content

Latest commit

 

History

History
132 lines (97 loc) · 4.82 KB

Blur.md

File metadata and controls

132 lines (97 loc) · 4.82 KB
title author description keywords dev_langs
Blur animation behavior
nmetulev
The Windows Community Toolkit Blur animation behavior selectively blurs a XAML element by increasing or decreasing pixel size (outdated docs).
windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, blur, blur animation
csharp
vb

Blur

Warning

This behavior is no longer available in the Windows Community Toolkit. Please use the effects from the Microsoft.Toolkit.Uwp.UI.Media package and the helpers such as the PipelineVisualFactory type.

The Blur animation blurs a XAML element by increasing or decreasing pixel size. Blur animation is applied to all the XAML elements in its parent control/panel. Blur animation doesn't affect the functionality of the control.

[!div class="nextstepaction"] Try it in the sample app

Syntax

<Page ...
    xmlns:interactivity="using:Microsoft.Xaml.Interactivity"  
    xmlns:behaviors="using:Microsoft.Toolkit.Uwp.UI.Animations.Behaviors"/>

<interactivity:Interaction.Behaviors>
    <behaviors:Blur x:Name="BlurBehavior" 
            Value="10" 
            Duration="2500" 
            Delay="250"
            EasingType="Linear"
            AutomaticallyStart="True"/>
</interactivity:Interaction.Behaviors>
MyUIElement.Blur(value: 5, duration: 2500, delay: 250).Start();
await MyUIElement.Blur(value: 5, duration: 2500, delay: 250).StartAsync();  // Blur animation can be awaited
MyUIElement.Blur(value:=5, duration:=2500, delay:=250).Start()
Await MyUIElement.Blur(value:=5, duration:=2500, delay:=250).StartAsync()    ' Blur animation can be awaited

Sample Output

Blur Behavior animation

Properties

Property Type Description
Value double The blur amount
Duration double The duration in milliseconds
Delay double The delay for the animation to begin

Methods

Methods Return Type Description
Blur(AnimationSet, Double, Double, Double) AnimationSet Animates the gaussian blur of the the UIElement
Blur(FrameworkElement, Double, Double, Double) AnimationSet Animates the gaussian blur of the the UIElement

Examples

  • Use this to shift the focus to foreground controls.

    Sample Code

    <Grid>
    <Grid>
        <interactivity:Interaction.Behaviors>
            <behaviors:Blur x:Name="BlurBehavior" Value="5" Duration="2500" Delay="0" AutomaticallyStart="True"/>
        </interactivity:Interaction.Behaviors>
        <!-- XAML Element to be Blurred -->
        <!-- Background(even for Transparent background) of this Grid will also be Blurred -->
    </Grid>
    <!-- Foreground XAML Element -->
</Grid>

    Sample Output

    Use Case 1 Output

  • Use this to create chaining animations with other animations. Visit the AnimationSet documentation for more information.

    Sample Code

    var anim = MyUIElement.Blur(5).Fade(0.5f).Rotate(30);
anim.SetDurationForAll(2500);
anim.SetDelay(250);
anim.Completed += animation_completed;
anim.Start();
    Dim anim = MyUIElement.Blur(5).Fade(0.5F).Rotate(30)
anim.SetDurationForAll(2500)
anim.SetDelay(250)
AddHandler anim.Completed, AddressOf animation_completed
anim.Start()

    Sample Output

    Use Case 2 Output

Sample Project

Blur Behavior Sample Page Source. You can see this in action in the Windows Community Toolkit Sample App.

Requirements

Device family Universal, 10.0.16299.0 or higher
Namespace Microsoft.Toolkit.Uwp.UI.Animations
NuGet package Microsoft.Toolkit.Uwp.UI.Animations

API

Related Topics