Timeline Class

Reference

Definition

Namespace:: Microsoft.UI.Xaml.Media.Animation

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.

Edit

Defines a duration and other behavior properties for a Windows Runtime animation. Timeline is the base class for Storyboard and all the Windows Runtime animation types, including those from the animation library and those used for custom animations in visual states or page-level XAML.

public ref class Timeline : DependencyObject

/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class Timeline : DependencyObject

[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class Timeline : DependencyObject

Public Class Timeline
Inherits DependencyObject

Inheritance: Object Platform::Object IInspectable DependencyObject Timeline

Derived: Microsoft.UI.Xaml.Media.Animation.ColorAnimation

Microsoft.UI.Xaml.Media.Animation.ColorAnimationUsingKeyFrames

Microsoft.UI.Xaml.Media.Animation.DoubleAnimation

Microsoft.UI.Xaml.Media.Animation.DoubleAnimationUsingKeyFrames

Microsoft.UI.Xaml.Media.Animation.DragItemThemeAnimation

More…

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Remarks

Timeline defines the Duration property that controls how long an animation runs once started. Timeline also defines these behavior properties, which are common to all animations types, and to Storyboard:

Timeline also defines the Completed event for Storyboard and animations. Handling the Completed event isn't necessary or most UI animation scenarios.

The relationship between Storyboard and the animation types is that a Storyboard is a container that can group multiple animations, and acts as the controller for starting and stopping the contained animations. When you set Timeline properties on a Storyboard as opposed to individual animations within a Storyboard, the Timeline properties set in the Storyboard typically override those from the combined animations. For more info see Storyboarded animations.

Timeline has a strongly typed collection class that is used for properties that take a set of Timeline values, such as Storyboard.Children. For more info see TimelineCollection.

Timeline derived classes

Timeline is the parent class for several immediately derived classes that support the storyboarded animation system and also the built-in library animations. Here are some of the notable derived classes:

Storyboard: A container and controller for other storyboarded animations that each target a particular object and property.
Typed animations: Each of these is used to animate a property that takes a particular value type, or an object. + ColorAnimation, ColorAnimationUsingKeyFrames
DoubleAnimation, DoubleAnimationUsingKeyFrames
ObjectAnimationUsingKeyFrames
PointAnimation, PointAnimationUsingKeyFrames
Theme animations: These are animations defined by the animation library that you use for common UI interactions.+ DragItemThemeAnimation
DragOverThemeAnimation
DropTargetItemThemeAnimation
FadeInThemeAnimation
FadeOutThemeAnimation
PointerDownThemeAnimation
PointerUpThemeAnimation
PopInThemeAnimation
PopOutThemeAnimation
RepositionThemeAnimation
SplitCloseThemeAnimation
SplitOpenThemeAnimation
SwipeBackThemeAnimation
SwipeHintThemeAnimation

Note

Theme transitions don't derive from Timeline, they derive from Transition.

Constructors

Timeline()

Provides base class initialization behavior for Timeline-derived classes.

Properties

AllowDependentAnimations	Gets or sets a value that determines whether dependent animations should be permitted to run, throughout the app.
AutoReverse	Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration.
AutoReverseProperty	Identifies the AutoReverse dependency property.
BeginTime	Gets or sets the time at which this Timeline should begin.
BeginTimeProperty	Identifies the BeginTime dependency property.
Dispatcher	Always returns `null` in a Windows App SDK app. Use DispatcherQueue instead. (Inherited from DependencyObject)
DispatcherQueue	Gets the `DispatcherQueue` that this object is associated with. The `DispatcherQueue` represents a facility that can access the `DependencyObject` on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject)
Duration	Gets or sets the length of time for which this timeline plays, not counting repetitions.
DurationProperty	Identifies the Duration dependency property.
FillBehavior	Gets or sets a value that specifies how the animation behaves after it reaches the end of its active period.
FillBehaviorProperty	Identifies the FillBehavior dependency property.
RepeatBehavior	Gets or sets the repeating behavior of this timeline.
RepeatBehaviorProperty	Identifies the RepeatBehavior dependency property.
SpeedRatio	Gets or sets the rate, relative to its parent, at which time progresses for this Timeline.
SpeedRatioProperty	Identifies for the SpeedRatio dependency property.

Methods

ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
GetAnimationBaseValue(DependencyProperty)	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)

Events

Completed

Occurs when the Storyboard object has completed playing.

Applies to

Share via