BooleanKeyFrame.InterpolateValue(Boolean, Double) 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.

Returns the interpolated value of a specific key frame at the progress increment provided.

public:
 bool InterpolateValue(bool baseValue, double keyFrameProgress);

public bool InterpolateValue (bool baseValue, double keyFrameProgress);

member this.InterpolateValue : bool * double -> bool

Public Function InterpolateValue (baseValue As Boolean, keyFrameProgress As Double) As Boolean

Parameters

baseValue: Boolean

The value to animate from.

keyFrameProgress: Double

A value between 0.0 and 1.0, inclusive, that specifies the percentage of time that has elapsed for this key frame.

Returns

Boolean

The output value of this key frame given the specified base value and progress.

Exceptions

ArgumentOutOfRangeException

Occurs if keyFrameProgress is not between 0.0 and 1.0, inclusive.

Remarks

The base value is typically the initial value of the property being animated or the Value of the previous key frame.

Most implementations will return the value of baseValue when keyFrameProgress is 0.0.

Applies to