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.
Inheritance
- Object
- DependencyObject
- Timeline
Syntax
Attributes
- MarshalingBehaviorAttribute(Agile)
- StaticAttribute(Windows.UI.Xaml.Media.Animation.ITimelineStatics, NTDDI_WIN8)
- ThreadingAttribute(Both)
- VersionAttribute(NTDDI_WIN8)
- WebHostHiddenAttribute()
Members
The Timeline class has these types of members:
Constructors
The Timeline class has these constructors.
| Constructor | Description |
|---|---|
| Timeline | Provides base class initialization behavior for Timeline-derived classes. |
Events
The Timeline class has these events.
| Event | Description |
|---|---|
| Completed | Occurs when the Storyboard object has completed playing. |
Methods
The Timeline class has these methods. It also inherits methods from the Object class.
| Method | Description |
|---|---|
| ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject) |
| GetAnimationBaseValue | Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject) |
| GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject) |
| ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject) |
| SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject) |
Properties
The Timeline class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read/write | Gets or sets a value that determines whether dependent animations should be permitted to run, throughout the app. | |
| Read/write | Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration. | |
| Read-only | Identifies the AutoReverse dependency property. | |
| Read/write | Gets or sets the time at which this Timeline should begin. | |
| Read-only | Identifies the BeginTime dependency property. | |
| Read-only | Gets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject) | |
| Read/write | Gets or sets the length of time for which this timeline plays, not counting repetitions. | |
| Read-only | Identifies the Duration dependency property. | |
| Read/write | Gets or sets a value that specifies how the animation behaves after it reaches the end of its active period. | |
| Read-only | Identifies the FillBehavior dependency property. | |
| Read/write | Gets or sets the repeating behavior of this timeline. | |
| Read-only | Identifies the RepeatBehavior dependency property. | |
| Read/write | Gets or sets the rate, relative to its parent, at which time progresses for this Timeline. | |
| Read-only | Identifies for the SpeedRatio dependency property. |
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:
- AutoReverse
- BeginTime
- FillBehavior
- RepeatBehavior
- SpeedRatio (not commonly used)
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.
Requirements
|
Minimum supported client | Windows 8 [Windows Store apps only] |
|---|---|
|
Minimum supported server | Windows Server 2012 [Windows Store apps only] |
|
Namespace |
|
|
Metadata |
|
See also
- DependencyObject
- Storyboard
- Storyboarded animations
- Storyboarded animations for visual states
- Key-frame animations and easing function animations
Build date: 12/4/2012
