DoubleAnimationUsingKeyFrames DoubleAnimationUsingKeyFrames DoubleAnimationUsingKeyFrames Class

Animates the value of a Double property along a set of key frames.

Syntax

Declaration

public sealed class DoubleAnimationUsingKeyFramespublic sealed class DoubleAnimationUsingKeyFramesPublic NotInheritable Class DoubleAnimationUsingKeyFrames
<DoubleAnimationUsingKeyFrames>
  oneOrMoreDoubleKeyFrames
</DoubleAnimationUsingKeyFrames>

Inheritance Hierarchy

Inherited Members

, , , , , , , , , , , , , , , , , , , , ,

Remarks

Examples

The following example moves a rectangle across a screen. The example uses the DoubleAnimationUsingKeyFrames class to animate the X property of a TranslateTransform applied to a Rectangle. This animation uses three key frames in the following manner:

  1. During the first three seconds, it uses an instance of the LinearDoubleKeyFrame class to move the rectangle along a path at a steady rate from its starting position to the 500 position. Linear key frames like LinearDoubleKeyFrame create a smooth linear transition between values.
  2. At the end of the fourth second, it uses an instance of the DiscreteDoubleKeyFrame class to suddenly move the rectangle to the next position. Discrete key frames like DiscreteDoubleKeyFrame create sudden jumps between values. In this example, the rectangle is at the starting position and then suddenly appears at the 500 position.
  3. In the final two seconds, it uses an instance of the SplineDoubleKeyFrame class to move the rectangle back to its starting position. Spline key frames like SplineDoubleKeyFrame create a variable transition between values according to the value of the KeySpline property. In this example, the rectangle begins by moving slowly and then speeds up exponentially toward the end of the time segment.
<StackPanel>
    <StackPanel.Resources>
        <Storyboard x:Name="myStoryboard">

            <!-- Animate the TranslateTransform's X property
             from 0 to 350, then 50,
             then 200 over 10 seconds. -->
            <DoubleAnimationUsingKeyFrames
          Storyboard.TargetName="MyAnimatedTranslateTransform"
          Storyboard.TargetProperty="X"
          Duration="0:0:10" EnableDependentAnimation="True">

                <!-- Using a LinearDoubleKeyFrame, the rectangle moves 
                 steadily from its starting position to 500 over 
                 the first 3 seconds.  -->
                <LinearDoubleKeyFrame Value="500" KeyTime="0:0:3" />

                <!-- Using a DiscreteDoubleKeyFrame, the rectangle suddenly 
                 appears at 400 after the fourth second of the animation. -->
                <DiscreteDoubleKeyFrame Value="400" KeyTime="0:0:4" />

                <!-- Using a SplineDoubleKeyFrame, the rectangle moves 
                 back to its starting point. The
                 animation starts out slowly at first and then speeds up. 
                 This KeyFrame ends after the 6th
                 second. -->
                <SplineDoubleKeyFrame KeySpline="0.6,0.0 0.9,0.00" Value="0" KeyTime="0:0:6" />

            </DoubleAnimationUsingKeyFrames>
        </Storyboard>
    </StackPanel.Resources>
    <Rectangle Fill="Blue" Width="50" Height="50" Loaded="Start_Animation">
        <Rectangle.RenderTransform>
            <TranslateTransform x:Name="MyAnimatedTranslateTransform" 
             X="0" Y="0" />
        </Rectangle.RenderTransform>
    </Rectangle>
</StackPanel>
' Start the animation when the object loads
Private Sub Start_Animation(ByVal sender As Object, ByVal e As EventArgs)
    myStoryboard.Begin()
End Sub
using System;
using System.Collections.Generic;
using System.Linq;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Documents;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Media.Animation;
using Windows.UI.Xaml.Shapes;

namespace doubleanimationusingkeyframes2
{
    public partial class Page : UserControl
    {
        public Page()
        {
            InitializeComponent();
        }
        // <SnippetDoubleanimationusingkeyframes2>
        // Start the animation when the object loads
        private void Start_Animation(object sender, RoutedEventArgs e)
        {
            myStoryboard.Begin();
        }
        // </SnippetDoubleanimationusingkeyframes2>

    }
}

Constructors summary

Initializes a new instance of the DoubleAnimationUsingKeyFrames class.

Properties summary

Gets or sets a value that declares whether animated properties that are considered dependent animations should be permitted to use this animation declaration.

Identifies the EnableDependentAnimation dependency property.

Gets the collection of DoubleKeyFrame objects that define the animation.

Constructors

  • DoubleAnimationUsingKeyFrames()
    DoubleAnimationUsingKeyFrames()
    DoubleAnimationUsingKeyFrames()
    DoubleAnimationUsingKeyFrames()

    Initializes a new instance of the DoubleAnimationUsingKeyFrames class.

    public DoubleAnimationUsingKeyFrames()public DoubleAnimationUsingKeyFrames()Public Function DoubleAnimationUsingKeyFrames() As

Properties

  • EnableDependentAnimation
    EnableDependentAnimation
    EnableDependentAnimation
    EnableDependentAnimation

    Gets or sets a value that declares whether animated properties that are considered dependent animations should be permitted to use this animation declaration.

    public bool EnableDependentAnimation { get; set; }public bool EnableDependentAnimation { get; set; }Public ReadWrite Property EnableDependentAnimation As bool
    <DoubleAnimationUsingKeyFrames EnableDependentAnimation="bool" />
    

    Property Value

    • bool
      bool
      bool

      true if the animation can be used for a dependent animation case. false if the animation cannot be used for a dependent animation case. The default is false.

    Remarks

    What's considered a dependent animation?

    Not all custom animations you create can run by default in a Windows Runtime app, if the animation system determines that the animation might cause bad performance in your UI. Animations where the system determines there could be a performance impact are called dependent animations. It's dependent because your animation is actively and frequently updating objects on the UI thread, which is also where current user input and other programmatic updates are making runtime changes to UI.

    A dependent animation that's consuming extensive system resources on the UI thread can make the app appear unresponsive in certain situations. If your animation causes a layout change or otherwise has the potential to impact performance on the UI thread, you often need to explicitly enable the animation to see it run. That's what the EnableDependentAnimation property on specific animation classes is for. Use this property with caution, because setting it to true means you are deliberately acknowledging that the animation might slow down other operations on the UI thread when it runs.

    For more info, see Storyboarded animations. That topic includes a list of the criteria for an independent animation. An animation is a dependent animation if it doesn't satisfy at least one of those criteria. For the specific property you intend to animate, and for the specifics of your animation, compare your intended animation to the criteria to see whether it would be considered dependent or independent by the system.

    Another way to discover whether your animations are dependent is that you might receive a warning from your XAML design surface or tool after you compose that animation, and the warning indicates that you'll need to set EnableDependentAnimation to true to see your animation run.

    As an app developer, you can also choose to apply an app-wide setting that always disables dependent animations, even those where EnableDependentAnimation is true. See AllowDependentAnimations. This is useful to you as an app developer if you're consuming controls where the templates have dependent animations, and you've identified that as a performance problem, but you don't want to have to retemplate the whole control to turn those animations off.

  • EnableDependentAnimationProperty
    EnableDependentAnimationProperty
    EnableDependentAnimationProperty
    EnableDependentAnimationProperty

    Identifies the EnableDependentAnimation dependency property.

    public static DependencyProperty EnableDependentAnimationProperty { get; }public static DependencyProperty EnableDependentAnimationProperty { get; }Public Static ReadOnly Property EnableDependentAnimationProperty As DependencyProperty

    Property Value

  • KeyFrames
    KeyFrames
    KeyFrames
    KeyFrames

    Gets the collection of DoubleKeyFrame objects that define the animation.

    public DoubleKeyFrameCollection KeyFrames { get; }public DoubleKeyFrameCollection KeyFrames { get; }Public ReadOnly Property KeyFrames As DoubleKeyFrameCollection
    <DoubleAnimationUsingKeyFrames>
      oneOrMoreDoubleKeyFrames
    </DoubleAnimationUsingKeyFrames>
    

    Property Value

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.UI.Xaml.Markup.ContentPropertyAttribute
Windows.Foundation.Metadata.ThreadingAttribute
Windows.Foundation.Metadata.WebHostHiddenAttribute
Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.StaticAttribute

Details

Assembly

Windows.UI.Xaml.Media.Animation.dll