CustomAnimation<TValue,TKeyFrame> Class

Definition

Namespace:

Microsoft.Toolkit.Uwp.UI.Animations

Assembly:

Microsoft.Toolkit.Uwp.UI.Animations.dll

Package:

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

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

public abstract class CustomAnimation<TValue,TKeyFrame> : Microsoft.Toolkit.Uwp.UI.Animations.ImplicitAnimation<TValue,TKeyFrame> where TKeyFrame : struct

type CustomAnimation<'Value, 'KeyFrame (requires 'KeyFrame : struct)> = class
    inherit ImplicitAnimation<'Value, 'KeyFrame (requires 'KeyFrame : struct)>

Public MustInherit Class CustomAnimation(Of TValue, TKeyFrame)
Inherits ImplicitAnimation(Of TValue, TKeyFrame)

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>

ImplicitAnimation<TValue,TKeyFrame>

CustomAnimation<TValue,TKeyFrame>

Derived

Microsoft.Toolkit.Uwp.UI.Animations.ColorAnimation

Microsoft.Toolkit.Uwp.UI.Animations.QuaternionAnimation

Microsoft.Toolkit.Uwp.UI.Animations.ScalarAnimation

Microsoft.Toolkit.Uwp.UI.Animations.Vector2Animation

Microsoft.Toolkit.Uwp.UI.Animations.Vector3Animation

Microsoft.Toolkit.Uwp.UI.Animations.Vector4Animation

Constructors

CustomAnimation<TValue,TKeyFrame>()

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
From	Gets or sets the optional starting value for the animation. (Inherited from Animation<TValue,TKeyFrame>)
ImplicitTarget	Gets or sets the optional implicit target for the animation. This can act as a trigger property for the animation. (Inherited from ImplicitAnimation<TValue,TKeyFrame>)
KeyFrames	Gets or sets the optional keyframe collection for the current animation. Setting this will overwrite the To and From values. (Inherited from Animation<TValue,TKeyFrame>)
Layer	Gets or sets the target framework layer for the animation. This is only supported for a set of animation types (see the docs for more on this). Furthermore, this is ignored when the animation is being used as an implicit composition animation. The default value is Composition.
Repeat	Gets or sets the repeat option for the animation. (Inherited from Animation)
Target	Gets or sets the target property for the animation.
To	Gets or sets the final value for the animation. (Inherited from Animation<TValue,TKeyFrame>)

Methods

AppendToBuilder(AnimationBuilder, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<EasingType>, Nullable<EasingMode>)
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. (Inherited from Animation<TValue,TKeyFrame>)
GetAnimation(UIElement, String)	Gets a Windows.UI.Composition.CompositionAnimation from the current node. This animation might be used either as an implicit show/hide animation, or as a direct implicit animation. (Inherited from ImplicitAnimation<TValue,TKeyFrame>)
GetParsedValues()	Gets the parsed TKeyFrame values from Animation<TValue,TKeyFrame>. (Inherited from Animation<TValue,TKeyFrame>)

Events

AnimationPropertyChanged

Raised whenever a property that influences the animation changes. This event is used by ImplicitAnimationSet to update the animations collection assigned to a target Windows.UI.Xaml.UIElement when any of the individual animations is modified. (Inherited from ImplicitAnimation<TValue,TKeyFrame>)