ColorAnimationUsingKeyFrames ColorAnimationUsingKeyFrames ColorAnimationUsingKeyFrames Class

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

Syntax

Declaration

public sealed class ColorAnimationUsingKeyFramespublic sealed class ColorAnimationUsingKeyFramesPublic NotInheritable Class ColorAnimationUsingKeyFrames
<ColorAnimationUsingKeyFrames ...>
  oneOrMoreColorKeyFrames
</ColorAnimationUsingKeyFrames>

Inheritance Hierarchy

Inherited Members

Inherited properties

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

Inherited methods

, , , , , ,

Inherited events

Remarks

Examples

The following example uses the ColorAnimationUsingKeyFrames class to animate the Background property of a StackPanel. This animation uses three key frames in the following manner:

  1. During the first two seconds, LinearColorKeyFrame gradually changes the color from green to red. Linear key frames like LinearColorKeyFrame create a smooth linear transition between values.
  2. During the end of the next half second, DiscreteColorKeyFrame quickly changes the color from red to yellow. Discrete key frames like DiscreteColorKeyFrame create sudden changes between values; the animation occurs quickly and has no interpolation at all between values.
  3. During the final two seconds, SplineColorKeyFrame changes the color again, this time from yellow back to green. Spline key frames like SplineColorKeyFrame create a variable transition between values according to the values of the KeySpline property. A KeySpline provides a way to alter the relationship of time versus value during the animation duration to be nonlinear, and in particular the relationship can be a curve that would be difficult to produce with individual key frames. In this example, the change in color begins slowly and speeds up exponentially toward the end of the time segment.
<StackPanel x:Name="myStackPanel" Background="Red"
Loaded="Start_Animation">
    <StackPanel.Resources>
        <Storyboard x:Name="colorStoryboard">

            <ColorAnimationUsingKeyFrames Storyboard.TargetName="myStackPanel" 
      Storyboard.TargetProperty="(Panel.Background).(SolidColorBrush.Color)">
                
                <!-- Go from green to red in the first 2 seconds. LinearColorKeyFrame creates
                a smooth, linear animation between values. -->
                <LinearColorKeyFrame Value="Blue" KeyTime="00:00:02" />

                <!-- In the next half second, go to yellow. DiscreteColorKeyFrame creates a 
                sudden jump between values. -->
                <DiscreteColorKeyFrame Value="Yellow" KeyTime="00:00:2.5" />

                <!-- In the final 2 seconds of the animation, go from yellow back to green. SplineColorKeyFrame 
                creates a variable transition between values depending on the KeySpline property. In this example,
                the animation starts off slow but toward the end of the time segment, it speeds up exponentially.-->
                <SplineColorKeyFrame Value="Green" KeyTime="00:00:4.5" KeySpline="0.6,0.0 0.9,0.00" />

            </ColorAnimationUsingKeyFrames>
        </Storyboard>
    </StackPanel.Resources>
</StackPanel>
// Start the animation when the object loads
private void Start_Animation(object sender, RoutedEventArgs e)
{
    colorStoryboard.Begin();
}
' Start the animation when the object loads
Private Sub Start_Animation(ByVal sender As Object, ByVal e As EventArgs)
    colorStoryboard.Begin()
End Sub

Constructors summary

Initializes a new instance of the ColorAnimationUsingKeyFrames 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 ColorKeyFrame objects that define the animation.

Constructors

  • ColorAnimationUsingKeyFrames()
    ColorAnimationUsingKeyFrames()
    ColorAnimationUsingKeyFrames()
    ColorAnimationUsingKeyFrames()

    Initializes a new instance of the ColorAnimationUsingKeyFrames class.

    public ColorAnimationUsingKeyFrames()public New()Public Sub New()public ColorAnimationUsingKeyFrames()

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 boolpublic bool EnableDependentAnimation { get; set; }
    <ColorAnimationUsingKeyFrames 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 DependencyPropertypublic static DependencyProperty EnableDependentAnimationProperty { get; }

    Property Value

  • KeyFrames
    KeyFrames
    KeyFrames
    KeyFrames

    Gets the collection of ColorKeyFrame objects that define the animation.

    public ColorKeyFrameCollection KeyFrames { get; }public ColorKeyFrameCollection KeyFrames { get; }Public ReadOnly Property KeyFrames As ColorKeyFrameCollectionpublic ColorKeyFrameCollection KeyFrames { get; }
    <ColorAnimationUsingKeyFrames ...>
      oneOrMoreColorKeyFrames
    </ColorAnimationUsingKeyFrames>
    

    Property Value

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

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

Details

Assembly

Windows.UI.Xaml.Media.Animation.dll