Storyboard Class

Definition

Namespace:

System.Windows.Media.Animation

Assembly:

PresentationFramework.dll

A container timeline that provides object and property targeting information for its child animations.

public ref class Storyboard : System::Windows::Media::Animation::ParallelTimeline

public class Storyboard : System.Windows.Media.Animation.ParallelTimeline

type Storyboard = class
    inherit ParallelTimeline

Public Class Storyboard
Inherits ParallelTimeline

Inheritance

Object

DispatcherObject

DependencyObject

Freezable

Animatable

Timeline

TimelineGroup

ParallelTimeline

Storyboard

Remarks

Interactively Controlling Storyboards

A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in markup, you specify the Name property of the BeginStoryboard object that creates it; for an example, see How to: Use Event Triggers to Control a Storyboard After It Starts. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's Begin method and specify true to make it controllable. For an example, see How to: Control a Storyboard After It Starts.

Data Binding and Animating Timelines

Most timeline properties can be data bound or animated; however, because of the way the timing system works, data bound or animated timelines do not behave like other data bound or animated objects. To understand their behavior, it helps to understand what it means to activate a timeline.

When a timeline is activated, copies are made of the timeline and its child timelines. These copies are frozen (made read-only) and Clock objects are created from them. These clocks do the actual work of animating the targeted properties. If a timeline is data bound or animated, a snapshot of its current values is made when its clock is created. Even though the original timeline might continue to change, its clock does not.

For a timeline to reflect data binding or animation changes, its clock must be re-created. Clocks are not re-created for you automatically. The following are several ways to apply timeline changes:

• If the timeline is or belongs to a Storyboard, you can make it reflect changes by reapplying its storyboard using a BeginStoryboard or the Begin method. This has the side effect of also restarting the animation. In code, you can use the Seek method to advance the storyboard back to its previous position.

• If you applied an animation directly to a property using the BeginAnimation method, call the BeginAnimation method again and pass it the animation that has been modified.

• If you are working directly at the clock level, create and apply a new set of clocks and use them to replace the previous set of created clocks.

For an example of a data bound animation, see Key Spline Animation Sample .

Constructors

Storyboard()

Initializes a new instance of the Storyboard class.

Fields

TargetNameProperty	Identifies the TargetName attached property.
TargetProperty	Identifies the Target attached property.
TargetPropertyProperty	Identifies the TargetProperty attached property.

Properties

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)
Children	Gets or sets the collection of direct child Timeline objects of the TimelineGroup. (Inherited from TimelineGroup)
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)
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)
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)
SlipBehavior	Gets or sets a value that specifies how this timeline will behave when one or more of its Timeline children slips. (Inherited from ParallelTimeline)
SpeedRatio	Gets or sets the rate, relative to its parent, at which time progresses for this Timeline. (Inherited from Timeline)

Attached Properties

Target	Gets or sets the object that should be animated.
TargetName	Gets or sets the name of the object to animate. The object must be a FrameworkElement, FrameworkContentElement, or Freezable.
TargetProperty

Methods

AddChild(Object)	Adds a child Timeline to this TimelineGroup. (Inherited from TimelineGroup)
AddText(String)	Adds a text string as a child of this Timeline. (Inherited from TimelineGroup)
AllocateClock()	Creates a type-specific clock for this timeline. (Inherited from TimelineGroup)
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)
Begin()	Applies the animations associated with this Storyboard to their targets and initiates them.
Begin(FrameworkContentElement)	Applies the animations associated with this Storyboard to their targets and initiates them.
Begin(FrameworkContentElement, Boolean)	Applies the animations associated with this Storyboard to their targets and initiates them.
Begin(FrameworkContentElement, HandoffBehavior)	Applies the animations associated with this Storyboard to their targets and initiates them, using the specified HandoffBehavior.
Begin(FrameworkContentElement, HandoffBehavior, Boolean)	Applies the animations associated with this Storyboard to their targets and initiates them, using the specified HandoffBehavior.
Begin(FrameworkElement)	Applies the animations associated with this Storyboard to their targets and initiates them.
Begin(FrameworkElement, Boolean)	Applies the animations associated with this Storyboard to their targets and initiates them.
Begin(FrameworkElement, FrameworkTemplate)	Applies the animations associated with this Storyboard to their targets within the specified template and initiates them.
Begin(FrameworkElement, FrameworkTemplate, Boolean)	Applies the animations associated with this Storyboard to their targets within the specified template and initiates them.
Begin(FrameworkElement, FrameworkTemplate, HandoffBehavior)	Applies the animations associated with this Storyboard to their targets within the specified template and initiates them.
Begin(FrameworkElement, FrameworkTemplate, HandoffBehavior, Boolean)	Applies the animations associated with this Storyboard to their targets within the specified template and initiates them.
Begin(FrameworkElement, HandoffBehavior)	Applies the animations associated with this Storyboard to their targets and initiates them, using the specified HandoffBehavior.
Begin(FrameworkElement, HandoffBehavior, Boolean)	Applies the animations associated with this Storyboard to their targets and initiates them.
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 Storyboard, 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 the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable)
CloneCurrentValue()	Creates a modifiable clone of this ParallelTimeline object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. (Inherited from ParallelTimeline)
CloneCurrentValueCore(Freezable)	Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. (Inherited from 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()	Instantiates a new ClockGroup object, using this instance. (Inherited from TimelineGroup)
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 the Storyboard class.
Equals(Object)	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject)
Freeze()	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable)
FreezeCore(Boolean)	Makes this Timeline unmodifiable or determines whether it can be made unmodifiable. (Inherited from Timeline)
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 Timeline object. (Inherited from Timeline)
GetCurrentGlobalSpeed()	Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard.
GetCurrentGlobalSpeed(FrameworkContentElement)	Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard.
GetCurrentGlobalSpeed(FrameworkElement)	Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard.
GetCurrentIteration()	Retrieves the CurrentIteration of the Clock that was created for this Storyboard.
GetCurrentIteration(FrameworkContentElement)	Retrieves the CurrentIteration of the Clock that was created for this Storyboard.
GetCurrentIteration(FrameworkElement)	Retrieves the CurrentIteration of the Clock that was created for this Storyboard.
GetCurrentProgress()	Retrieves the CurrentProgress of the Clock that was created for this Storyboard.
GetCurrentProgress(FrameworkContentElement)	Retrieves the CurrentProgress of the Clock that was created for this Storyboard.
GetCurrentProgress(FrameworkElement)	Retrieves the CurrentProgress of the Clock that was created for this Storyboard.
GetCurrentState()	Retrieves the CurrentState of the Clock that was created for this Storyboard.
GetCurrentState(FrameworkContentElement)	Retrieves the CurrentState of the Clock that was created for this Storyboard.
GetCurrentState(FrameworkElement)	Retrieves the CurrentState of the Clock that was created for this Storyboard.
GetCurrentTime()	Retrieves the CurrentTime of the Clock that was created for this Storyboard.
GetCurrentTime(FrameworkContentElement)	Retrieves the CurrentTime of the Clock that was created for this Storyboard.
GetCurrentTime(FrameworkElement)	Retrieves the CurrentTime of the Clock that was created for this Storyboard.
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 Timeline. Resource references, data bindings, and animations are not copied, but their current values are. (Inherited from Timeline)
GetHashCode()	Gets a hash code for this DependencyObject. (Inherited from DependencyObject)
GetIsPaused()	Retrieves a value that indicates whether the Clock that was created for this Storyboard is paused.
GetIsPaused(FrameworkContentElement)	Retrieves a value that indicates whether the Clock that was created for this Storyboard is paused.
GetIsPaused(FrameworkElement)	Retrieves a value that indicates whether the Clock that was created for this Storyboard is paused.
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)	Return the natural duration (duration of a single iteration) from a specified Clock. (Inherited from ParallelTimeline)
GetTarget(DependencyObject)	Retrieves the Target value of the specified Timeline.
GetTargetName(DependencyObject)	Retrieves the TargetName value of the specified Timeline.
GetTargetProperty(DependencyObject)	Retrieves the TargetProperty value of the specified Timeline.
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 Freezable object is modified. (Inherited from Freezable)
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(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable)
Pause()	Pauses the Clock that was created for this Storyboard.
Pause(FrameworkContentElement)	Pauses the Clock of the specified FrameworkContentElement associated with this Storyboard.
Pause(FrameworkElement)	Pauses the Clock of the specified FrameworkElement associated with this Storyboard.
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)
Remove()	Removes the Clock objects that were created for this Storyboard. Animations that belong to this Storyboard no longer affect the properties they once animated, regardless of their FillBehavior setting.
Remove(FrameworkContentElement)	Removes the Clock objects that were created for this Storyboard. Animations that belong to this Storyboard no longer affect the properties they once animated, regardless of their FillBehavior setting.
Remove(FrameworkElement)	Removes the Clock objects that were created for this Storyboard. Animations that belong to this Storyboard no longer affect the properties they once animated, regardless of their FillBehavior setting.
Resume()	Resumes the Clock that was created for this Storyboard.
Resume(FrameworkContentElement)	Resumes the Clock that was created for this Storyboard.
Resume(FrameworkElement)	Resumes the Clock that was created for this Storyboard.
Seek(FrameworkContentElement, TimeSpan, TimeSeekOrigin)	Seeks this Storyboard to the specified position. The Storyboard performs the requested seek when the next clock tick occurs.
Seek(FrameworkElement, TimeSpan, TimeSeekOrigin)	Seeks this Storyboard to the specified position. The Storyboard performs the requested seek when the next clock tick occurs.
Seek(TimeSpan)	Seeks this Storyboard to the specified position. The Storyboard performs the requested seek when the next clock tick occurs.
Seek(TimeSpan, TimeSeekOrigin)	Seeks this Storyboard to the specified position. The Storyboard performs the requested seek when the next clock tick occurs.
SeekAlignedToLastTick(FrameworkContentElement, TimeSpan, TimeSeekOrigin)	Seeks this Storyboard to a new position immediately (synchronously).
SeekAlignedToLastTick(FrameworkElement, TimeSpan, TimeSeekOrigin)	Seeks this Storyboard to a new position immediately (synchronously).
SeekAlignedToLastTick(TimeSpan)	Seeks this Storyboard to a new position immediately (synchronously).
SeekAlignedToLastTick(TimeSpan, TimeSeekOrigin)	Seeks this Storyboard to a new position immediately (synchronously).
SetCurrentValue(DependencyProperty, Object)	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject)
SetSpeedRatio(Double)	Sets the interactive speed ratio for the Clock that was created for this Storyboard.
SetSpeedRatio(FrameworkContentElement, Double)	Sets the interactive speed ratio of the Clock that was created for this Storyboard.
SetSpeedRatio(FrameworkElement, Double)	Sets the interactive speed ratio of the Clock that was created for this Storyboard.
SetTarget(DependencyObject, DependencyObject)	Makes the specified Timeline target the dependency object.
SetTargetName(DependencyObject, String)	Makes the specified Timeline target the dependency object with the specified name.
SetTargetProperty(DependencyObject, PropertyPath)	Makes the specified Timeline target the specified dependency property.
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)
ShouldSerializeProperty(DependencyProperty)	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject)
SkipToFill()	Advances the current time of this storyboard's Clock to the end of its active period.
SkipToFill(FrameworkContentElement)	Advances the current time of this storyboard's Clock to the end of its active period.
SkipToFill(FrameworkElement)	Advances the current time of this storyboard's Clock to the end of its active period.
Stop()	Stops the Clock that was created for this Storyboard.
Stop(FrameworkContentElement)	Stops the Clock that was created for this Storyboard.
Stop(FrameworkElement)	Stops the Clock that was created for this Storyboard.
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

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

IAddChild.AddChild(Object)	Adds a child object. (Inherited from TimelineGroup)
IAddChild.AddText(String)	Adds the text content of a node to the object. (Inherited from TimelineGroup)