CharAnimationUsingKeyFrames Class
System.Windows.Threading::DispatcherObject
System.Windows::DependencyObject
System.Windows::Freezable
System.Windows.Media.Animation::Animatable
System.Windows.Media.Animation::Timeline
System.Windows.Media.Animation::AnimationTimeline
System.Windows.Media.Animation::CharAnimationBase
System.Windows.Media.Animation::CharAnimationUsingKeyFrames
Assembly: PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
The CharAnimationUsingKeyFrames type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | CharAnimationUsingKeyFrames | Initializes a new instance of the CharAnimationUsingKeyFrames class. |
| Name | Description | |
|---|---|---|
![]() | AccelerationRatio | Gets or sets a value specifying the percentage of the timeline's Duration spent accelerating the passage of time from zero to its maximum rate. (Inherited from Timeline.) |
![]() | AutoReverse | Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration. (Inherited from Timeline.) |
![]() | BeginTime | Gets or sets the time at which this Timeline should begin. (Inherited from Timeline.) |
![]() | CanFreeze | Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.) |
![]() | DecelerationRatio | Gets or sets a value specifying the percentage of the timeline's Duration spent decelerating the passage of time from its maximum rate to zero. (Inherited from Timeline.) |
![]() | DependencyObjectType | Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.) |
![]() | Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.) |
![]() | Duration | Gets or sets the length of time for which this timeline plays, not counting repetitions. (Inherited from Timeline.) |
![]() | FillBehavior | Gets or sets a value that specifies how the Timeline behaves after it reaches the end of its active period. (Inherited from Timeline.) |
![]() | HasAnimatedProperties | Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.) |
![]() | IsDestinationDefault | Gets a value that indicates whether this animation uses the defaultDestinationValue parameter of the GetCurrentValue method as its destination value. (Inherited from AnimationTimeline.) |
![]() | IsFrozen | Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.) |
![]() | IsSealed | Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.) |
![]() | KeyFrames | Gets or sets the collection of CharKeyFrame objects that define the animation. |
![]() | Name | Gets or sets the name of this Timeline. (Inherited from Timeline.) |
![]() | RepeatBehavior | Gets or sets the repeating behavior of this timeline. (Inherited from Timeline.) |
![]() | SpeedRatio | Gets or sets the rate, relative to its parent, at which time progresses for this Timeline. (Inherited from Timeline.) |
![]() | TargetPropertyType | Gets the type of value this animation generates. (Inherited from CharAnimationBase.) |
| Name | Description | |
|---|---|---|
![]() | AddChild | Adds a child CharKeyFrame to this CharAnimationUsingKeyFrames. |
![]() | AddText | Adds a text string as a child of this CharAnimationUsingKeyFrames. |
![]() | AllocateClock | Creates a Clock for this AnimationTimeline. (Inherited from AnimationTimeline.) |
![]() | ApplyAnimationClock(DependencyProperty, AnimationClock) | Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.) |
![]() | ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior) | Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.) |
![]() | BeginAnimation(DependencyProperty, AnimationTimeline) | Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.) |
![]() | BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior) | Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.) |
![]() | CheckAccess | Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) |
![]() | ClearValue(DependencyProperty) | Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.) |
![]() | ClearValue(DependencyPropertyKey) | Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.) |
![]() | Clone | Creates a modifiable clone of this CharAnimationUsingKeyFrames, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. |
![]() | CloneCore | Makes this instance a deep copy of the specified CharAnimationUsingKeyFrames. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. (Overrides Freezable::CloneCore(Freezable).) |
![]() | CloneCurrentValue | Creates a modifiable clone of this CharAnimationUsingKeyFrames object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. |
![]() | CloneCurrentValueCore | Makes this instance a modifiable deep copy of the specified CharAnimationUsingKeyFrames using current property values. Resource references, data bindings, and animations are not copied, but their current values are. (Overrides Freezable::CloneCurrentValueCore(Freezable).) |
![]() | CoerceValue | Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.) |
![]() | CreateClock() | Creates a new AnimationClock from this AnimationTimeline. (Inherited from AnimationTimeline.) |
![]() | CreateClock(Boolean) | Creates a new Clock from this Timeline and specifies whether the new Clock is controllable. If this Timeline has children, a tree of clocks is created with this Timeline as the root. (Inherited from Timeline.) |
![]() | CreateInstance | Initializes a new instance of the Freezable class. (Inherited from Freezable.) |
![]() | CreateInstanceCore | Creates a new instance of CharAnimationUsingKeyFrames. (Overrides Freezable::CreateInstanceCore().) |
![]() | Equals | Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | Freeze() | Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.) |
![]() | FreezeCore | Makes this instance of CharAnimationUsingKeyFrames object unmodifiable or determines whether it can be made unmodifiable. (Overrides Timeline::FreezeCore(Boolean).) |
![]() | GetAnimationBaseValue | Returns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.) |
![]() | GetAsFrozen | Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.) |
![]() | GetAsFrozenCore | Makes this instance a clone of the specified CharAnimationUsingKeyFrames object. (Overrides Timeline::GetAsFrozenCore(Freezable).) |
![]() | GetCurrentValue(Char, Char, AnimationClock) | Gets the current value of the animation. (Inherited from CharAnimationBase.) |
![]() | GetCurrentValue(Object, Object, AnimationClock) | Gets the current value of the animation. (Inherited from CharAnimationBase.) |
![]() | GetCurrentValueAsFrozen | Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.) |
![]() | GetCurrentValueAsFrozenCore | Makes this instance a frozen clone of the specified CharAnimationUsingKeyFrames. Resource references, data bindings, and animations are not copied, but their current values are. (Overrides Timeline::GetCurrentValueAsFrozenCore(Freezable).) |
![]() | GetCurrentValueCore | Calculates a value that represents the current value of the property being animated, as determined by this instance of CharAnimationUsingKeyFrames. (Overrides CharAnimationBase::GetCurrentValueCore(Char, Char, AnimationClock).) |
![]() | GetHashCode | Gets a hash code for this DependencyObject. (Inherited from DependencyObject.) |
![]() | GetLocalValueEnumerator | Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.) |
![]() | GetNaturalDuration | Returns the length of a single iteration of this Timeline. (Inherited from Timeline.) |
![]() | GetNaturalDurationCore | Provide a custom natural Duration when the Duration property is set to Automatic. (Overrides AnimationTimeline::GetNaturalDurationCore(Clock).) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetValue | Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.) |
![]() | InvalidateProperty | Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | OnChanged | Called when the current CharAnimationUsingKeyFrames object is modified. (Overrides Freezable::OnChanged().) |
![]() | OnFreezablePropertyChanged(DependencyObject, DependencyObject) | Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable.) |
![]() | OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) | This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable.) |
![]() | OnPropertyChanged | Overrides the DependencyObject implementation of OnPropertyChanged to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable.) |
![]() | ReadLocalValue | Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.) |
![]() | ReadPreamble | Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable.) |
![]() | SetCurrentValue | Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.) |
![]() | SetValue(DependencyProperty, Object) | Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.) |
![]() | SetValue(DependencyPropertyKey, Object) | Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.) |
![]() | ShouldSerializeKeyFrames | Returns true if the value of the KeyFrames property of this instance of CharAnimationUsingKeyFrames should be value-serialized. |
![]() | ShouldSerializeProperty | Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | VerifyAccess | Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) |
![]() | WritePostscript | Raises the Changed event for the Freezable and invokes its OnChanged method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable.) |
![]() | WritePreamble | Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable.) |
| Name | Description | |
|---|---|---|
![]() | Changed | Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.) |
![]() | Completed | Occurs when this timeline has completely finished playing: it will no longer enter its active period. (Inherited from Timeline.) |
![]() | CurrentGlobalSpeedInvalidated | Occurs when the rate at which time progresses for the timeline's clock changes. (Inherited from Timeline.) |
![]() | CurrentStateInvalidated | Occurs when the CurrentState property of the timeline's Clock is updated. (Inherited from Timeline.) |
![]() | CurrentTimeInvalidated | Occurs when the CurrentTime property of the timeline's Clock is updated. (Inherited from Timeline.) |
![]() | RemoveRequested | Occurs when the clock created for this timeline or one of its parent timelines is removed. (Inherited from Timeline.) |
| Name | Description | |
|---|---|---|
![]() ![]() | IAddChild::AddChild | Adds a child object. |
![]() ![]() | IAddChild::AddText | Adds the text content of a node to the object. |
![]() ![]() | IKeyFrameAnimation::KeyFrames | Gets or sets an ordered collection P:System.Windows.Media.Animation.IKeyFrameAnimation.KeyFrames associated with this animation sequence. |
A key frame animation's target values are defined by its KeyFrames property, which contains a collection of CharKeyFrame objects. Each CharKeyFrame 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.
This example shows how to animate the value of a property that takes a Double by using key frames.
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, which repeats indefinitely, uses three key frames in the following manner:
During the first three seconds, 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.
At the end of the fourth second, 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.
In the final two seconds, 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.
<!-- This example shows how to use the DoubleAnimationUsingKeyFrames to animate the position of an object. Key frame animations enable you to create complex animations by specifying multiple destination values and controlling the animation's interpolation method. --> <Page xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" Title="DoubleAnimationUsingKeyFrames Example" Background="White" Margin="20"> <Canvas Width="610" Height="300"> <!-- The position of this rectangle is animated using a key frame animation. --> <Rectangle Canvas.Top="100" Canvas.Left="10" Height="100" Width="100" Stroke="Black" StrokeThickness="5"> <Rectangle.RenderTransform> <TranslateTransform x:Name="AnimatedTranslateTransform" /> </Rectangle.RenderTransform> <Rectangle.Triggers> <EventTrigger RoutedEvent="Rectangle.Loaded"> <BeginStoryboard> <Storyboard> <!-- Animate the TranslateTransform.X property using 3 KeyFrames which animates the rectangle along a straight line. This animation repeats indefinitely. --> <DoubleAnimationUsingKeyFrames Storyboard.TargetName="AnimatedTranslateTransform" Storyboard.TargetProperty="X" Duration="0:0:6" RepeatBehavior="Forever"> <!-- 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> </BeginStoryboard> </EventTrigger> </Rectangle.Triggers> </Rectangle> </Canvas> </Page>
For the complete sample, see KeyFrame Animation Sample.
For consistency with other animation examples, the code versions of this example use a Storyboard object to apply the DoubleAnimationUsingKeyFrames. Alternatively, when applying a single animation in code, it is simpler to use the BeginAnimation method instead of using a Storyboard. For an example, see How to: Animate a Property Without Using a Storyboard.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

