SingleAnimationBase.GetCurrentValue Method (Object, Object, AnimationClock)

Gets the current value of the animation.

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

public override sealed Object GetCurrentValue(
	Object defaultOriginValue,
	Object defaultDestinationValue,
	AnimationClock animationClock
)

Parameters

defaultOriginValue
Type: System.Object
The origin value provided to the animation if the animation does not have its own start value.
defaultDestinationValue
Type: System.Object
The destination value provided to the animation if the animation does not have its own destination value.
animationClock
Type: System.Windows.Media.Animation.AnimationClock
The AnimationClock which can generate the CurrentTime or CurrentProgress value to be used by the animation to generate its output value.

Return Value

Type: System.Object
The current value of the animation.

The value of the defaultOriginValue parameter depends on the animation’s position in the composition chain:

  • If the animation is in the first position in a composition chain and it replaces another animation, defaultOriginValue is the output of that animation at the time it was replaced.

  • If the animation is in the first position in a composition chain and no animation exists to replace, defaultOriginValue is the base value of the animated property.

  • If this animation is not in the first position of a composition chain, then defaultOriginValue is the value that is returned by the previous animation in the composition chain that has an AnimationClock that is not Stopped.

The value of the defaultDestinationValue parameter depends on whether there is a previous property Trigger composition layer.

  • If there is a previous property Trigger composition layer, defaultDestinationValue is the output from that layer.

  • If there is no previous composition layer, defaultDestinationValue is the base value of the property that you are animating.

For more information about animation composition, see the Animation and Timing System Overview. For more information about creating custom animation types, see the Custom Animations Overview.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft