StringAnimationBase.GetCurrentValueCore Method

Reference

Definition

Namespace:: System.Windows.Media.Animation

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Calculates a value that represents the current value of the property being animated, as determined by the host animation.

protected:
 abstract System::String ^ GetCurrentValueCore(System::String ^ defaultOriginValue, System::String ^ defaultDestinationValue, System::Windows::Media::Animation::AnimationClock ^ animationClock);

protected abstract string GetCurrentValueCore (string defaultOriginValue, string defaultDestinationValue, System.Windows.Media.Animation.AnimationClock animationClock);

abstract member GetCurrentValueCore : string * string * System.Windows.Media.Animation.AnimationClock -> string

Protected MustOverride Function GetCurrentValueCore (defaultOriginValue As String, defaultDestinationValue As String, animationClock As AnimationClock) As String

Parameters

defaultOriginValue: String

The suggested origin value, used if the animation does not have its own explicitly set start value.

defaultDestinationValue: String

The suggested destination value, used if the animation does not have its own explicitly set end value.

animationClock: AnimationClock

An AnimationClock that generates the CurrentTime or CurrentProgress used by the host animation.

Returns

String

The calculated value of the property, as determined by the current animation.

Remarks

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.

Applies to

Share via