.NET Framework Class Library for Silverlight
ColorAnimationUsingKeyFrames Class

Animates the value of a Color property along a set of KeyFrames over a specified Duration.

Namespace:  System.Windows.Media.Animation
Assembly:  System.Windows (in System.Windows.dll)
Syntax

Visual Basic (Declaration)
<ContentPropertyAttribute("KeyFrames", True)> _
Public NotInheritable Class ColorAnimationUsingKeyFrames _
    Inherits Timeline
Visual Basic (Usage)
Dim instance As ColorAnimationUsingKeyFrames
C#
[ContentPropertyAttribute("KeyFrames", true)]
public sealed class ColorAnimationUsingKeyFrames : Timeline
XAML Object Element Usage
<ColorAnimationUsingKeyFrames ...>
  oneOrMoreColorKeyFrames
</ColorAnimationUsingKeyFrames>

XAML Values

oneOrMoreColorKeyFrames

One or more object elements that define the key frames for the animation. These object elements represent one of the classes deriving from ColorKeyFrame. These are typically any combination of LinearColorKeyFrame, DiscreteColorKeyFrame, and SplineColorKeyFrame. Object elements defined here become members of the ColorKeyFrameCollection collection when code accesses the KeyFrames property at run time.

Remarks

A key frame animation's target values are defined by its KeyFrames property, which contains a collection of ColorKeyFrame objects. Each ColorKeyFrame defines a segment of the animation with its own target Value and KeyTime. When the animation runs, it progresses from one key value to the next at the specified key times.

There are three types of ColorKeyFrame classes, one for each supported interpolation method: LinearColorKeyFrame, DiscreteColorKeyFrame, and SplineColorKeyFrame.

Unlike a ColorAnimation, a ColorAnimationUsingKeyFrames can have more than two target values. You can also control the interpolation method of individual ColorKeyFrame segments.

When declaring a ColorAnimationUsingKeyFrames in XAML, the order of the ColorKeyFrame object elements is not significant, because the KeyTime controls the timing and therefore the order in which the key frames are executed. However, it is good markup style to keep the element order the same as the KeyTime sequence order.

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 between values at all.

  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.

Run this sample

XAML
<StackPanel Background="White" x:Name="myStackPanel"
            Loaded="Start_Animation">
    <StackPanel.Resources>
        <Storyboard x:Name="colorStoryboard">
            <ColorAnimationUsingKeyFrames BeginTime="00:00:00" 
             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="Red" 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>
Visual Basic
' Start the animation when the object loads
Private Sub Start_Animation(ByVal sender As Object, ByVal e As EventArgs)
    colorStoryboard.Begin()
End Sub
C#
// Start the animation when the object loads
private void Start_Animation(object sender, EventArgs e)
{
    colorStoryboard.Begin();
}
Inheritance Hierarchy

System..::.Object
  System.Windows..::.DependencyObject
    System.Windows.Media.Animation..::.Timeline
      System.Windows.Media.Animation..::.ColorAnimationUsingKeyFrames
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

See Also

Reference

Other Resources

Tags :


Page view tracker