Class ByteKeyFrame

Abstract class that, when implemented, defines an animation segment with its own target value and interpolation method for a ByteAnimationUsingKeyFrames.

Inheritance
System.Object
DependencyObject
ByteKeyFrame
DiscreteByteKeyFrame
EasingByteKeyFrame
LinearByteKeyFrame
SplineByteKeyFrame
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: System.Windows.Media.Animation
Assembly: OpenSilver.dll
Syntax
public abstract class ByteKeyFrame : DependencyObject, IDependencyObject, IKeyFrame

Constructors

| Improve this Doc View Source

ByteKeyFrame()

Initializes a new instance of the ByteKeyFrame class.

Declaration
protected ByteKeyFrame()
| Improve this Doc View Source

ByteKeyFrame(Byte)

Initializes a new instance of the ByteKeyFrame class that has the specified target Value.

Declaration
protected ByteKeyFrame(byte value)
Parameters
Type Name Description
System.Byte value

The Value of the new ByteKeyFrame instance.
| Improve this Doc View Source

ByteKeyFrame(Byte, KeyTime)

Initializes a new instance of the ByteKeyFrame class that has the specified target Value and KeyTime.

Declaration
protected ByteKeyFrame(byte value, KeyTime keyTime)
Parameters
Type Name Description
System.Byte value

The Value of the new ByteKeyFrame instance.
KeyTime keyTime

The KeyTime of the new ByteKeyFrame instance.

Fields

| Improve this Doc View Source

KeyTimeProperty

Identifies the KeyTime dependency property.

Declaration
public static readonly DependencyProperty KeyTimeProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

ValueProperty

Identifies the Value dependency property.

Declaration
public static readonly DependencyProperty ValueProperty
Field Value
Type Description
DependencyProperty

Properties

| Improve this Doc View Source

KeyTime

Gets or sets the time at which the key frame's target Value should be reached.

Declaration
public KeyTime KeyTime { get; set; }
Property Value
Type Description
KeyTime

The time at which the key frame's current value should be equal to its Value property. The default value is Uniform.
| Improve this Doc View Source

Value

Gets or sets the key frame's target value.

Declaration
public byte Value { get; set; }
Property Value
Type Description
System.Byte

The key frame's target value, which is the value of this key frame at its specified KeyTime. The default value is 0.

Methods

| Improve this Doc View Source

InterpolateValue(Byte, Double)

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

Declaration
public byte InterpolateValue(byte baseValue, double keyFrameProgress)
Parameters
Type Name Description
System.Byte baseValue

The value to animate from.
System.Double keyFrameProgress

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

The output value of this key frame given the specified base value and progress.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

Occurs if keyFrameProgress is not between 0.0 and 1.0, inclusive.
| Improve this Doc View Source

InterpolateValueCore(Byte, Double)

Calculates the value of a key frame at the progress increment provided.

Declaration
protected virtual byte InterpolateValueCore(byte baseValue, double keyFrameProgress)
Parameters
Type Name Description
System.Byte baseValue

The value to animate from; typically the value of the previous key frame.
System.Double keyFrameProgress

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

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

Explicit Interface Implementations

| Improve this Doc View Source

IKeyFrame.Value

Declaration
object IKeyFrame.Value { get; set; }
Returns
Type Description
System.Object

Implements

Extension Methods