ByteAnimationUsingKeyFrames Class

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Animates the value of a Byte property along a set of KeyFrames.

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

Inheritance Hierarchy

System.Object
System.Windows.Threading.DispatcherObject
System.Windows.DependencyObject
System.Windows.Freezable
System.Windows.Media.Animation.Animatable
System.Windows.Media.Animation.Timeline
System.Windows.Media.Animation.AnimationTimeline
System.Windows.Media.Animation.ByteAnimationBase
System.Windows.Media.Animation.ByteAnimationUsingKeyFrames

Syntax

C++

[ContentPropertyAttribute("KeyFrames")]
public class ByteAnimationUsingKeyFrames : ByteAnimationBase, 
	IKeyFrameAnimation, IAddChild

Constructors

	Name	Description
	ByteAnimationUsingKeyFrames()	Initializes a new instance of the ByteAnimationUsingKeyFrames class.

Properties

	Name	Description
	AccelerationRatio	Gets or sets a value specifying the percentage of the timeline's Duration spent accelerating the passage of time from zero to its maximum rate. (Inherited from Timeline.)
	AutoReverse	Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration. (Inherited from Timeline.)
	BeginTime	Gets or sets the time at which this Timeline should begin. (Inherited from Timeline.)
	CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
	DecelerationRatio	Gets or sets a value specifying the percentage of the timeline's Duration spent decelerating the passage of time from its maximum rate to zero. (Inherited from Timeline.)
	DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)
	Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
	Duration	Gets or sets the length of time for which this timeline plays, not counting repetitions. (Inherited from Timeline.)
	FillBehavior	Gets or sets a value that specifies how the Timeline behaves after it reaches the end of its active period. (Inherited from Timeline.)
	HasAnimatedProperties	Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.(Inherited from Animatable.)
	IsAdditive	Gets a value that specifies whether the animation's output value is added to the base value of the property being animated.
	IsCumulative	Gets or sets a value that specifies whether the animation's value accumulates when it repeats.
	IsDestinationDefault	Gets a value that indicates whether this animation uses the defaultDestinationValue parameter of the GetCurrentValue method as its destination value.(Inherited from AnimationTimeline.)
	IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
	IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)
	KeyFrames	Gets or sets the collection of ByteKeyFrame objects that define the animation.
	Name	Gets or sets the name of this Timeline. (Inherited from Timeline.)
	RepeatBehavior	Gets or sets the repeating behavior of this timeline. (Inherited from Timeline.)
	SpeedRatio	Gets or sets the rate, relative to its parent, at which time progresses for this Timeline. (Inherited from Timeline.)
	TargetPropertyType	Gets the type of value this animation generates.(Inherited from ByteAnimationBase.)

Methods

	Name	Description
	AddChild(Object)	Adds a child ByteKeyFrame to this ByteAnimationUsingKeyFrames.
	AddText(String)	Adds a text string as a child of this ByteAnimationUsingKeyFrames.
	AllocateClock()	Creates a Clock for this AnimationTimeline.(Inherited from AnimationTimeline.)
	ApplyAnimationClock(DependencyProperty, AnimationClock)	Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)
	ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)	Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.(Inherited from Animatable.)
	BeginAnimation(DependencyProperty, AnimationTimeline)	Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)
	BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)	Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
	CheckAccess()	Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)
	ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
	ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
	Clone()	Creates a modifiable clone of this ByteAnimationUsingKeyFrames, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.
	CloneCore(Freezable)	Makes this instance a deep copy of the specified ByteAnimationUsingKeyFrames. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.(Overrides Freezable.CloneCore(Freezable).)
	CloneCurrentValue()	Creates a modifiable clone of this ByteAnimationUsingKeyFrames object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.
	CloneCurrentValueCore(Freezable)	Makes this instance a modifiable deep copy of the specified ByteAnimationUsingKeyFrames using current property values. Resource references, data bindings, and animations are not copied, but their current values are.(Overrides Freezable.CloneCurrentValueCore(Freezable).)
	CoerceValue(DependencyProperty)	Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.(Inherited from DependencyObject.)
	CreateClock()	Creates a new AnimationClock from this AnimationTimeline. (Inherited from AnimationTimeline.)
	CreateClock(Boolean)	Creates a new Clock from this Timeline and specifies whether the new Clock is controllable. If this Timeline has children, a tree of clocks is created with this Timeline as the root. (Inherited from Timeline.)
	CreateInstance()	Initializes a new instance of the Freezable class. (Inherited from Freezable.)
	CreateInstanceCore()	Creates a new instance of ByteAnimationUsingKeyFrames. (Overrides Freezable.CreateInstanceCore().)
	Equals(Object)	Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	Freeze()	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
	FreezeCore(Boolean)	Makes this instance of ByteAnimationUsingKeyFrames object unmodifiable or determines whether it can be made unmodifiable.(Overrides Timeline.FreezeCore(Boolean).)
	GetAnimationBaseValue(DependencyProperty)	Returns the non-animated value of the specified DependencyProperty.(Inherited from Animatable.)
	GetAsFrozen()	Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetAsFrozenCore(Freezable)	Makes this instance a clone of the specified ByteAnimationUsingKeyFrames object. (Overrides Timeline.GetAsFrozenCore(Freezable).)
	GetCurrentValue(Byte, Byte, AnimationClock)	Gets the current value of the animation.(Inherited from ByteAnimationBase.)
	GetCurrentValue(Object, Object, AnimationClock)	Gets the current value of the animation.(Inherited from ByteAnimationBase.)
	GetCurrentValueAsFrozen()	Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.(Inherited from Freezable.)
	GetCurrentValueAsFrozenCore(Freezable)	Makes this instance a frozen clone of the specified ByteAnimationUsingKeyFrames. Resource references, data bindings, and animations are not copied, but their current values are.(Overrides Timeline.GetCurrentValueAsFrozenCore(Freezable).)
	GetCurrentValueCore(Byte, Byte, AnimationClock)	Calculates a value that represents the current value of the property being animated, as determined by this instance of ByteAnimationUsingKeyFrames.(Overrides ByteAnimationBase.GetCurrentValueCore(Byte, Byte, AnimationClock).)
	GetHashCode()	Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)
	GetLocalValueEnumerator()	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
	GetNaturalDuration(Clock)	Returns the length of a single iteration of this Timeline. (Inherited from Timeline.)
	GetNaturalDurationCore(Clock)	Provide a custom natural Duration when the Duration property is set to Automatic. (Overrides AnimationTimeline.GetNaturalDurationCore(Clock).)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	GetValue(DependencyProperty)	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
	InvalidateProperty(DependencyProperty)	Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	OnChanged()	Called when the current ByteAnimationUsingKeyFrames object is modified.(Overrides Freezable.OnChanged().)
	OnFreezablePropertyChanged(DependencyObject, DependencyObject)	Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set.(Inherited from Freezable.)
	OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)	This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.(Inherited from Freezable.)
	OnPropertyChanged(DependencyPropertyChangedEventArgs)	Overrides the DependencyObject implementation of OnPropertyChanged to also invoke any Changed handlers in response to a changing dependency property of type Freezable.(Inherited from Freezable.)
	ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
	ReadPreamble()	Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties.(Inherited from Freezable.)
	SetCurrentValue(DependencyProperty, Object)	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
	SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
	SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
	ShouldSerializeKeyFrames()	Returns true if the value of the KeyFrames property of this instance of ByteAnimationUsingKeyFrames should be value-serialized.
	ShouldSerializeProperty(DependencyProperty)	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	VerifyAccess()	Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)
	WritePostscript()	Raises the Changed event for the Freezable and invokes its OnChanged method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties.(Inherited from Freezable.)
	WritePreamble()	Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable.)

Events

	Name	Description
	Changed	Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
	Completed	Occurs when this timeline has completely finished playing: it will no longer enter its active period. (Inherited from Timeline.)
	CurrentGlobalSpeedInvalidated	Occurs when the rate at which time progresses for the timeline's clock changes.(Inherited from Timeline.)
	CurrentStateInvalidated	Occurs when the CurrentState property of the timeline's Clock is updated.(Inherited from Timeline.)
	CurrentTimeInvalidated	Occurs when the CurrentTime property of the timeline's Clock is updated.(Inherited from Timeline.)
	RemoveRequested	Occurs when the clock created for this timeline or one of its parent timelines is removed.(Inherited from Timeline.)

Explicit Interface Implementations

	Name	Description
	IAddChild.AddChild(Object)	Adds a child object.
	IAddChild.AddText(String)	Adds the text content of a node to the object.
	IKeyFrameAnimation.KeyFrames	Gets or sets an ordered collection P:System.Windows.Media.Animation.IKeyFrameAnimation.KeyFrames associated with this animation sequence.

A key frame animation's target values are defined by its KeyFrames property, which contains a collection of ByteKeyFrame objects. Each ByteKeyFrame defines a segment of the animation with its own target Value and KeyTime. When the animation runs, it progresses from one key value to the next at the specified key times.

There are three types of ByteKeyFrame classes, one for each supported interpolation method: LinearByteKeyFrame, DiscreteByteKeyFrame, and SplineByteKeyFrame.

Unlike a ByteAnimation, a ByteAnimationUsingKeyFrames can have more than two of target values. You can also control the interpolation method of individual ByteKeyFrame segments.

Version Information

.NET Framework
Available since 3.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.