Animation<TValue,TKeyFrame> Class

Reference

Definition

Namespace:: Microsoft.Toolkit.Uwp.UI.Animations

Assembly:: Microsoft.Toolkit.Uwp.UI.Animations.dll

Package:: Microsoft.Toolkit.Uwp.UI.Animations v7.0.2

Package:: Microsoft.Toolkit.Uwp.UI.Animations v7.1.2

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.

A base model representing a typed animation that can be used in XAML.

[Windows.UI.Xaml.Markup.ContentProperty(Name="KeyFrames")]
public abstract class Animation<TValue,TKeyFrame> : Microsoft.Toolkit.Uwp.UI.Animations.Animation where TKeyFrame : struct

[<Windows.UI.Xaml.Markup.ContentProperty(Name="KeyFrames")>]
type Animation<'Value, 'KeyFrame (requires 'KeyFrame : struct)> = class
    inherit Animation

Public MustInherit Class Animation(Of TValue, TKeyFrame)
Inherits Animation

Type Parameters

TValue

The type to use for the public To and From properties. This can differ from TKeyFrame to facilitate XAML parsing.

TKeyFrame

The actual type of keyframe values in use.

Inheritance: Windows.UI.Xaml.DependencyObject

Animation
Animation<TValue,TKeyFrame>

Derived: Microsoft.Toolkit.Uwp.UI.Animations.ClipAnimation

Microsoft.Toolkit.Uwp.UI.Animations.EffectAnimation<TEffect,TValue,TKeyFrame>

Microsoft.Toolkit.Uwp.UI.Animations.ImplicitAnimation<TValue,TKeyFrame>

Microsoft.Toolkit.Uwp.UI.Animations.ShadowAnimation<TValue,TKeyFrame>

Attributes: Windows.UI.Xaml.Markup.ContentPropertyAttribute

Constructors

Animation<TValue,TKeyFrame>()

Fields

FromProperty	Identifies the dependency property.
KeyFramesProperty	Identifies the dependency property.
ToProperty	Identifies the dependency property.

Properties

Delay	Gets or sets the optional initial delay for the animation. (Inherited from Animation)
DelayBehavior	Gets or sets the delay behavior for the animation. The default value is set to Windows.UI.Composition.AnimationDelayBehavior.SetInitialValueBeforeDelay. This value is applicable when the current animation is used as either an implicit composition animation, or an explicit composition animation. If the current animation is instead running on the XAML layer (if used through CustomAnimation<TValue,TKeyFrame>), it will be ignored. (Inherited from Animation)
Duration	Gets or sets the animation duration. (Inherited from Animation)
EasingMode	Gets or sets the optional easing function mode for the animation. (Inherited from Animation)
EasingType	Gets or sets the optional easing function type for the animation. (Inherited from Animation)
ExplicitTarget	Gets the explicit target for the animation. This is the primary target property that is animated.
From	Gets or sets the optional starting value for the animation.
KeyFrames	Gets or sets the optional keyframe collection for the current animation. Setting this will overwrite the To and From values.
Repeat	Gets or sets the repeat option for the animation. (Inherited from Animation)
To	Gets or sets the final value for the animation.

Methods

AppendToBuilder(AnimationBuilder, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<EasingType>, Nullable<EasingMode>)	Appends the current animation to a target AnimationBuilder instance. This method is used when the current ITimeline instance is explicitly triggered.
AppendToBuilder(INormalizedKeyFrameAnimationBuilder<TKeyFrame>, Nullable<EasingType>, Nullable<EasingMode>)	Appends the current keyframe values to a target INormalizedKeyFrameAnimationBuilder<T> instance. This method will also automatically generate keyframes for To and From.
GetParsedValues()	Gets the parsed `TKeyFrame` values from Animation<TValue,TKeyFrame>.

Applies to

Share via