Skip to main content
ColorAnimation Class
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Animates the value of a Color property between two target values using linear interpolation over a specified .

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

SystemObject
   System.Windows.ThreadingDispatcherObject
     System.WindowsDependencyObject
       System.WindowsFreezable
         System.Windows.Media.AnimationAnimatable
           System.Windows.Media.AnimationTimeline
             System.Windows.Media.AnimationAnimationTimeline
               System.Windows.Media.AnimationColorAnimationBase
                System.Windows.Media.AnimationColorAnimation

public class ColorAnimation : ColorAnimationBase
public ref class ColorAnimation : ColorAnimationBase
type ColorAnimation = 
    class
        inherit ColorAnimationBase
    end
Public Class ColorAnimation
	Inherits ColorAnimationBase
NameDescription
System_CAPS_pubmethod ColorAnimation

Initializes a new instance of the ColorAnimation class.

System_CAPS_pubmethod ColorAnimation

Initializes a new instance of the ColorAnimation class that animates from the specified starting value to the specified destination value over the specified duration.

System_CAPS_pubmethod ColorAnimation

Initializes a new instance of the ColorAnimation class that animates from the specified starting value to the specified destination value over the specified duration and has the specified fill behavior.

System_CAPS_pubmethod ColorAnimation

Initializes a new instance of the ColorAnimation class that animates to the specified value over the specified duration. The starting value for the animation is the base value of the property being animated or the output from another animation.

System_CAPS_pubmethod ColorAnimation

Initializes a new instance of the ColorAnimation class that animates to the specified value over the specified duration and has the specified fill behavior. The starting value for the animation is the base value of the property being animated or the output from an another animation.

NameDescription
System_CAPS_pubproperty

Gets or sets a value specifying the percentage of the timeline's spent accelerating the passage of time from zero to its maximum rate. (Inherited from Timeline.)

System_CAPS_pubproperty

Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration. (Inherited from Timeline.)

System_CAPS_pubproperty

Gets or sets the time at which this Timeline should begin. (Inherited from Timeline.)

System_CAPS_pubproperty

Gets or sets the total amount by which the animation changes its starting value.

System_CAPS_pubproperty

Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)

System_CAPS_pubproperty

Gets or sets a value specifying the percentage of the timeline's spent decelerating the passage of time from its maximum rate to zero. (Inherited from Timeline.)

System_CAPS_pubproperty

Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)

System_CAPS_pubproperty

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubproperty

Gets or sets the length of time for which this timeline plays, not counting repetitions. (Inherited from Timeline.)

System_CAPS_pubproperty

Gets or sets the easing function applied to this animation.

System_CAPS_pubproperty

Gets or sets a value that specifies how the Timeline behaves after it reaches the end of its active period. (Inherited from Timeline.)

System_CAPS_pubproperty

Gets or sets the animation's starting value.

System_CAPS_pubproperty

Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.(Inherited from Animatable.)

System_CAPS_pubproperty

Gets or sets a value that indicates whether the target property's current value should be added to this animation's starting value.

System_CAPS_pubproperty

Gets or sets a value that specifies whether the animation's value accumulates when it repeats.

System_CAPS_pubproperty

Gets a value that indicates whether this animation uses the defaultDestinationValue parameter of the GetCurrentValue method as its destination value.(Inherited from AnimationTimeline.)

System_CAPS_pubproperty

Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)

System_CAPS_pubproperty

Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)

System_CAPS_pubproperty

Gets or sets the name of this Timeline. (Inherited from Timeline.)

System_CAPS_pubproperty

Gets or sets the repeating behavior of this timeline. (Inherited from Timeline.)

System_CAPS_pubproperty

Gets or sets the rate, relative to its parent, at which time progresses for this Timeline. (Inherited from Timeline.)

System_CAPS_pubproperty

Gets the type of value this animation generates.(Inherited from ColorAnimationBase.)

System_CAPS_pubproperty

Gets or sets the animation's ending value.

NameDescription
System_CAPS_protmethod AllocateClock

Creates a Clock for this AnimationTimeline.(Inherited from AnimationTimeline.)

System_CAPS_pubmethod ApplyAnimationClock

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)

System_CAPS_pubmethod ApplyAnimationClock

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.(Inherited from Animatable.)

System_CAPS_pubmethod BeginAnimation

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.)

System_CAPS_pubmethod BeginAnimation

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.)

System_CAPS_pubmethod CheckAccess

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethod ClearValue

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethod ClearValue

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)

System_CAPS_pubmethod Clone

Creates a modifiable clone of this ColorAnimation, 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.

System_CAPS_protmethod CloneCore

Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable.)

System_CAPS_pubmethod CloneCurrentValue

Creates a modifiable clone of this Timeline object, making deep copies of this object's current values. (Inherited from Timeline.)

System_CAPS_protmethod CloneCurrentValueCore

Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values.(Inherited from Freezable.)

System_CAPS_pubmethod 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.)

System_CAPS_pubmethod CreateClock

Creates a new AnimationClock from this AnimationTimeline. (Inherited from AnimationTimeline.)

System_CAPS_pubmethod CreateClock

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.)

System_CAPS_protmethod CreateInstance

Initializes a new instance of the Freezable class. (Inherited from Freezable.)

System_CAPS_protmethod CreateInstanceCore

Creates a new instance of the ColorAnimation.(Overrides FreezableCreateInstanceCore.)

System_CAPS_pubmethod Equals

Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethod Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethod Freeze

Makes the current object unmodifiable and sets its property to true. (Inherited from Freezable.)

System_CAPS_protmethod FreezeCore

Makes this Timeline unmodifiable or determines whether it can be made unmodifiable.(Inherited from Timeline.)

System_CAPS_pubmethod GetAnimationBaseValue

Returns the non-animated value of the specified DependencyProperty.(Inherited from Animatable.)

System_CAPS_pubmethod 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.)

System_CAPS_protmethod GetAsFrozenCore

Makes this instance a clone of the specified Timeline object. (Inherited from Timeline.)

System_CAPS_pubmethod GetCurrentValue

Gets the current value of the animation.(Inherited from ColorAnimationBase.)

System_CAPS_pubmethod GetCurrentValue

Gets the current value of the animation.(Inherited from ColorAnimationBase.)

System_CAPS_pubmethod 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.)

System_CAPS_protmethod GetCurrentValueAsFrozenCore

Makes this instance a frozen clone of the specified Timeline. Resource references, data bindings, and animations are not copied, but their current values are.(Inherited from Timeline.)

System_CAPS_protmethod GetCurrentValueCore

Calculates a value that represents the current value of the property being animated, as determined by the ColorAnimation. (Overrides ColorAnimationBaseGetCurrentValueCore.)

System_CAPS_pubmethod GetHashCode

Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethod GetLocalValueEnumerator

Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)

System_CAPS_protmethod GetNaturalDuration

Returns the length of a single iteration of this Timeline. (Inherited from Timeline.)

System_CAPS_protmethod GetNaturalDurationCore

Returns the length of a single iteration of this AnimationTimeline. (Inherited from AnimationTimeline.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod GetValue

Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethod InvalidateProperty

Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)

System_CAPS_protmethod MemberwiseClone

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethod OnChanged

Called when the current Freezable object is modified. (Inherited from Freezable.)

System_CAPS_protmethod OnFreezablePropertyChanged

Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set.(Inherited from Freezable.)

System_CAPS_protmethod OnFreezablePropertyChanged

This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.(Inherited from Freezable.)

System_CAPS_protmethod 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.)

System_CAPS_pubmethod ReadLocalValue

Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)

System_CAPS_protmethod 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.)

System_CAPS_pubmethod SetCurrentValue

Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)

System_CAPS_pubmethod SetValue

Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethod SetValue

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)

System_CAPS_protmethod ShouldSerializeProperty

Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethod VerifyAccess

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_protmethod 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.)

System_CAPS_protmethod 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.)

NameDescription
System_CAPS_pubfield System_CAPS_static ByProperty

Identifies the  dependency property.

System_CAPS_pubfield System_CAPS_static EasingFunctionProperty

Identifies the  dependency property.

System_CAPS_pubfield System_CAPS_static FromProperty

Identifies the  dependency property.

System_CAPS_pubfield System_CAPS_static ToProperty

Identifies the  dependency property.

NameDescription
System_CAPS_pubevent Changed

Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)

System_CAPS_pubevent Completed

Occurs when this timeline has completely finished playing: it will no longer enter its active period. (Inherited from Timeline.)

System_CAPS_pubevent CurrentGlobalSpeedInvalidated

Occurs when the rate at which time progresses for the timeline's clock changes.(Inherited from Timeline.)

System_CAPS_pubevent CurrentStateInvalidated

Occurs when the property of the timeline's Clock is updated.(Inherited from Timeline.)

System_CAPS_pubevent CurrentTimeInvalidated

Occurs when the property of the timeline's Clock is updated.(Inherited from Timeline.)

System_CAPS_pubevent RemoveRequested

Occurs when the clock created for this timeline or one of its parent timelines is removed.(Inherited from Timeline.)

An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a Shape a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value.

The ColorAnimation class creates a transition between two target values. To set its target values, use its , , and properties.  The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values.

Properties specified

Resulting behavior

The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.

and

The animation progresses from the value specified by the property to the value specified by the property.

and

The animation progresses from the value specified by the property to the value specified by the sum of the and properties.

The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.

The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.

System_CAPS_noteNote

If you set both the and properties, the property takes precedence and the property is ignored.

To use other interpolation methods or animate between more than two target values, use a ColorAnimationUsingKeyFrames object.

For information about applying multiple animations to a single property, see Key-Frame Animations Overview.

Because the ColorAnimation class inherits from Freezable, ColorAnimation objects gain several special features, which include the following: they can be declared as , shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by Freezable objects, see the Freezable Objects Overview.

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

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

Return to top