StringAnimationBase.GetCurrentValue Method

Definition

Namespace:

System.Windows.Media.Animation

Assembly:

PresentationCore.dll

Gets the current value of the animation.

Overloads

GetCurrentValue(Object, Object, AnimationClock)	Gets the current value of the animation.
GetCurrentValue(String, String, AnimationClock)	Gets the current value of the animation.

GetCurrentValue(Object, Object, AnimationClock)

Gets the current value of the animation.

public:
 override System::Object ^ GetCurrentValue(System::Object ^ defaultOriginValue, System::Object ^ defaultDestinationValue, System::Windows::Media::Animation::AnimationClock ^ animationClock);

public override sealed object GetCurrentValue (object defaultOriginValue, object defaultDestinationValue, System.Windows.Media.Animation.AnimationClock animationClock);

override this.GetCurrentValue : obj * obj * System.Windows.Media.Animation.AnimationClock -> obj

Public Overrides NotOverridable Function GetCurrentValue (defaultOriginValue As Object, defaultDestinationValue As Object, animationClock As AnimationClock) As Object

Parameters

defaultOriginValue

Object

The origin value provided to the animation if the animation does not have its own start value.

defaultDestinationValue

Object

The destination value provided to the animation if the animation does not have its own destination value.

animationClock

AnimationClock

The AnimationClock which can generate the CurrentTime or CurrentProgress value to be used by the animation to generate its output value.

Returns

Object

The current value of the 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.

GetCurrentValue(String, String, AnimationClock)

Gets the current value of the animation.

public:
 System::String ^ GetCurrentValue(System::String ^ defaultOriginValue, System::String ^ defaultDestinationValue, System::Windows::Media::Animation::AnimationClock ^ animationClock);

public string GetCurrentValue (string defaultOriginValue, string defaultDestinationValue, System.Windows.Media.Animation.AnimationClock animationClock);

override this.GetCurrentValue : string * string * System.Windows.Media.Animation.AnimationClock -> string

Public Function GetCurrentValue (defaultOriginValue As String, defaultDestinationValue As String, animationClock As AnimationClock) As String

Parameters

defaultOriginValue

String

The origin value provided to the animation if the animation does not have its own start value.

defaultDestinationValue

String

The destination value provided to the animation if the animation does not have its own destination value.

animationClock

AnimationClock

The AnimationClock which can generate the CurrentTime or CurrentProgress value to be used by the animation to generate its output value.

Returns

String

The current value of this 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.