Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Storyboard Methods

The Storyboard type exposes the following members.

  NameDescription
Protected method AddChild Adds a child Timeline to this TimelineGroup. (Inherited from TimelineGroup.)
Protected method AddText Adds a text string as a child of this Timeline. (Inherited from TimelineGroup.)
Protected method AllocateClock Creates a type-specific clock for this timeline. (Inherited from TimelineGroup.)
Public method 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.)
Public method 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.)
Public method Begin() Applies the animations associated with this Storyboard to their targets and initiates them.
Public method Begin(FrameworkContentElement) Applies the animations associated with this Storyboard to their targets and initiates them.
Public method Begin(FrameworkElement) Applies the animations associated with this Storyboard to their targets and initiates them.
Public method Begin(FrameworkContentElement, Boolean) Applies the animations associated with this Storyboard to their targets and initiates them.
Public method Begin(FrameworkContentElement, HandoffBehavior) Applies the animations associated with this Storyboard to their targets and initiates them, using the specified HandoffBehavior.
Public method Begin(FrameworkElement, Boolean) Applies the animations associated with this Storyboard to their targets and initiates them.
Public method Begin(FrameworkElement, FrameworkTemplate) Applies the animations associated with this Storyboard to their targets within the specified template and initiates them.
Public method Begin(FrameworkElement, HandoffBehavior) Applies the animations associated with this Storyboard to their targets and initiates them, using the specified HandoffBehavior.
Public method Begin(FrameworkContentElement, HandoffBehavior, Boolean) Applies the animations associated with this Storyboard to their targets and initiates them, using the specified HandoffBehavior.
Public method Begin(FrameworkElement, FrameworkTemplate, Boolean) Applies the animations associated with this Storyboard to their targets within the specified template and initiates them.
Public method Begin(FrameworkElement, FrameworkTemplate, HandoffBehavior) Applies the animations associated with this Storyboard to their targets within the specified template and initiates them.
Public method Begin(FrameworkElement, HandoffBehavior, Boolean) Applies the animations associated with this Storyboard to their targets and initiates them.
Public method Begin(FrameworkElement, FrameworkTemplate, HandoffBehavior, Boolean) Applies the animations associated with this Storyboard to their targets within the specified template and initiates them.
Public method 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.)
Public method 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.)
Public method CheckAccess Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public method ClearValue(DependencyProperty) Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public method ClearValue(DependencyPropertyKey) Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public method 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.
Protected method CloneCore Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable.)
Public method 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.)
Protected method CloneCurrentValueCore Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. (Inherited from Freezable.)
Public method CoerceValue 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.)
Public method CreateClock() Instantiates a new ClockGroup object, using this instance. (Inherited from TimelineGroup.)
Public method 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.)
Protected method CreateInstance Initializes a new instance of the Freezable class. (Inherited from Freezable.)
Protected method CreateInstanceCore Creates a new instance of the Storyboard class. (Overrides ParallelTimeline.CreateInstanceCore().)
Public method Equals Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Freeze() Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
Protected method FreezeCore Makes this Timeline unmodifiable or determines whether it can be made unmodifiable. (Inherited from Timeline.)
Public method GetAnimationBaseValue Returns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.)
Public method 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.)
Protected method GetAsFrozenCore Makes this instance a clone of the specified Timeline object. (Inherited from Timeline.)
Public method GetCurrentGlobalSpeed() Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard.
Public method GetCurrentGlobalSpeed(FrameworkContentElement) Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard.
Public method GetCurrentGlobalSpeed(FrameworkElement) Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard.
Public method GetCurrentIteration() Retrieves the CurrentIteration of the Clock that was created for this Storyboard.
Public method GetCurrentIteration(FrameworkContentElement) Retrieves the CurrentIteration of the Clock that was created for this Storyboard.
Public method GetCurrentIteration(FrameworkElement) Retrieves the CurrentIteration of the Clock that was created for this Storyboard.
Public method GetCurrentProgress() Retrieves the CurrentProgress of the Clock that was created for this Storyboard.
Public method GetCurrentProgress(FrameworkContentElement) Retrieves the CurrentProgress of the Clock that was created for this Storyboard.
Public method GetCurrentProgress(FrameworkElement) Retrieves the CurrentProgress of the Clock that was created for this Storyboard.
Public method GetCurrentState() Retrieves the CurrentState of the Clock that was created for this Storyboard.
Public method GetCurrentState(FrameworkContentElement) Retrieves the CurrentState of the Clock that was created for this Storyboard.
Public method GetCurrentState(FrameworkElement) Retrieves the CurrentState of the Clock that was created for this Storyboard.
Public method GetCurrentTime() Retrieves the CurrentTime of the Clock that was created for this Storyboard.
Public method GetCurrentTime(FrameworkContentElement) Retrieves the CurrentTime of the Clock that was created for this Storyboard.
Public method GetCurrentTime(FrameworkElement) Retrieves the CurrentTime of the Clock that was created for this Storyboard.
Public method 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.)
Protected method GetCurrentValueAsFrozenCore 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.)
Public method GetHashCode Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public method GetIsPaused() Retrieves a value that indicates whether the Clock that was created for this Storyboard is paused.
Public method GetIsPaused(FrameworkContentElement) Retrieves a value that indicates whether the Clock that was created for this Storyboard is paused.
Public method GetIsPaused(FrameworkElement) Retrieves a value that indicates whether the Clock that was created for this Storyboard is paused.
Public method GetLocalValueEnumerator Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Protected method GetNaturalDuration Returns the length of a single iteration of this Timeline. (Inherited from Timeline.)
Protected method GetNaturalDurationCore Return the natural duration (duration of a single iteration) from a specified Clock. (Inherited from ParallelTimeline.)
Public method Static member GetTarget Retrieves the Target value of the specified Timeline.
Public method Static member GetTargetName Retrieves the TargetName value of the specified Timeline.
Public method Static member GetTargetProperty Retrieves the TargetProperty value of the specified Timeline.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public method InvalidateProperty Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnChanged Called when the current Freezable object is modified. (Inherited from Freezable.)
Protected method OnFreezablePropertyChanged(DependencyObject, DependencyObject) Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable.)
Protected method 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.)
Protected method OnPropertyChanged 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.)
Public method Pause() Pauses the Clock that was created for this Storyboard.
Public method Pause(FrameworkContentElement) Pauses the Clock of the specified FrameworkContentElement associated with this Storyboard.
Public method Pause(FrameworkElement) Pauses the Clock of the specified FrameworkElement associated with this Storyboard.
Public method ReadLocalValue Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Protected method 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.)
Public method 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.
Public method 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.
Public method 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.
Public method Resume() Resumes the Clock that was created for this Storyboard.
Public method Resume(FrameworkContentElement) Resumes the Clock that was created for this Storyboard.
Public method Resume(FrameworkElement) Resumes the Clock that was created for this Storyboard.
Public method Seek(TimeSpan) Seeks this Storyboard to the specified position. The Storyboard performs the requested seek when the next clock tick occurs.
Public method Seek(TimeSpan, TimeSeekOrigin) Seeks this Storyboard to the specified position. The Storyboard performs the requested seek when the next clock tick occurs.
Public method Seek(FrameworkContentElement, TimeSpan, TimeSeekOrigin) Seeks this Storyboard to the specified position. The Storyboard performs the requested seek when the next clock tick occurs.
Public method Seek(FrameworkElement, TimeSpan, TimeSeekOrigin) Seeks this Storyboard to the specified position. The Storyboard performs the requested seek when the next clock tick occurs.
Public method SeekAlignedToLastTick(TimeSpan) Seeks this Storyboard to a new position immediately (synchronously).
Public method SeekAlignedToLastTick(TimeSpan, TimeSeekOrigin) Seeks this Storyboard to a new position immediately (synchronously).
Public method SeekAlignedToLastTick(FrameworkContentElement, TimeSpan, TimeSeekOrigin) Seeks this Storyboard to a new position immediately (synchronously).
Public method SeekAlignedToLastTick(FrameworkElement, TimeSpan, TimeSeekOrigin) Seeks this Storyboard to a new position immediately (synchronously).
Public method SetCurrentValue Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public method SetSpeedRatio(Double) Sets the interactive speed ratio for the Clock that was created for this Storyboard.
Public method SetSpeedRatio(FrameworkContentElement, Double) Sets the interactive speed ratio of the Clock that was created for this Storyboard.
Public method SetSpeedRatio(FrameworkElement, Double) Sets the interactive speed ratio of the Clock that was created for this Storyboard.
Public method Static member SetTarget Makes the specified Timeline target the dependency object.
Public method Static member SetTargetName Makes the specified Timeline target the dependency object with the specified name.
Public method Static member SetTargetProperty Makes the specified Timeline target the specified dependency property.
Public method SetValue(DependencyProperty, Object) Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public method 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.)
Protected method ShouldSerializeProperty Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public method SkipToFill() Advances the current time of this storyboard's Clock to the end of its active period.
Public method SkipToFill(FrameworkContentElement) Advances the current time of this storyboard's Clock to the end of its active period.
Public method SkipToFill(FrameworkElement) Advances the current time of this storyboard's Clock to the end of its active period.
Public method Stop() Stops the Clock that was created for this Storyboard.
Public method Stop(FrameworkContentElement) Stops the Clock that was created for this Storyboard.
Public method Stop(FrameworkElement) Stops the Clock that was created for this Storyboard.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method VerifyAccess Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Protected method 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.)
Protected method 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.)
Top
  NameDescription
Explicit interface implemetation Private method IAddChild.AddChild Adds a child object. (Inherited from TimelineGroup.)
Explicit interface implemetation Private method IAddChild.AddText Adds the text content of a node to the object. (Inherited from TimelineGroup.)
Top
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.