AnimationBuilder.TimedKeyFrames Method

Definition

Namespace:

Microsoft.Toolkit.Uwp.UI.Animations

Assembly:

Microsoft.Toolkit.Uwp.UI.Animations.dll

Package:

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

Overloads

TimedKeyFrames<T,TState>(String, TState, Action<ITimedKeyFrameAnimationBuilder<T>, TState>, Nullable<TimeSpan>, Nullable<RepeatOption>, Nullable<AnimationDelayBehavior>, FrameworkLayer)	Adds a custom animation based on timed keyframes to the current schedule.
TimedKeyFrames<T>(String, Action<ITimedKeyFrameAnimationBuilder<T>>, Nullable<TimeSpan>, Nullable<RepeatOption>, Nullable<AnimationDelayBehavior>, FrameworkLayer)	Adds a custom animation based on timed keyframes to the current schedule.

TimedKeyFrames<T,TState>(String, TState, Action<ITimedKeyFrameAnimationBuilder<T>, TState>, Nullable<TimeSpan>, Nullable<RepeatOption>, Nullable<AnimationDelayBehavior>, FrameworkLayer)

Adds a custom animation based on timed keyframes to the current schedule.

public Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder TimedKeyFrames<T,TState> (string property, TState state, Action<Microsoft.Toolkit.Uwp.UI.Animations.ITimedKeyFrameAnimationBuilder<T>,TState> build, TimeSpan? delay = default, Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption? repeatOption = default, Windows.UI.Composition.AnimationDelayBehavior? delayBehavior = default, Microsoft.Toolkit.Uwp.UI.Animations.FrameworkLayer layer = Microsoft.Toolkit.Uwp.UI.Animations.FrameworkLayer.Composition) where T : struct;

member this.TimedKeyFrames : string * 'State * Action<Microsoft.Toolkit.Uwp.UI.Animations.ITimedKeyFrameAnimationBuilder<'T>, 'State> * Nullable<TimeSpan> * Nullable<Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption> * Nullable<Windows.UI.Composition.AnimationDelayBehavior> * Microsoft.Toolkit.Uwp.UI.Animations.FrameworkLayer -> Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder (requires 'T : struct)

Public Function TimedKeyFrames(Of T As Structure, TState As Structure) (property As String, state As TState, build As Action(Of ITimedKeyFrameAnimationBuilder(Of T), TState), Optional delay As Nullable(Of TimeSpan) = Nothing, Optional repeatOption As Nullable(Of RepeatOption) = Nothing, Optional delayBehavior As Nullable(Of AnimationDelayBehavior) = Nothing, Optional layer As FrameworkLayer = Microsoft.Toolkit.Uwp.UI.Animations.FrameworkLayer.Composition) As AnimationBuilder

Type Parameters

T

The type of values to animate.

TState

The type of state to pass to the builder.

Parameters

property

String

The target property to animate.

state

TState

The state to pass to the builder.

build

Action<ITimedKeyFrameAnimationBuilder<T>,TState>

The callback to use to construct the custom animation.

delay

Nullable<TimeSpan>

The optional initial delay for the animation.

repeatOption

Nullable<RepeatOption>

The repeat option for the animation (defaults to one iteration).

delayBehavior

Nullable<Windows.UI.Composition.AnimationDelayBehavior>

The delay behavior to use (ignored if layer is Xaml).

layer

FrameworkLayer

The target framework layer to animate.

Returns

AnimationBuilder

The current AnimationBuilder instance.

TimedKeyFrames<T>(String, Action<ITimedKeyFrameAnimationBuilder<T>>, Nullable<TimeSpan>, Nullable<RepeatOption>, Nullable<AnimationDelayBehavior>, FrameworkLayer)

Adds a custom animation based on timed keyframes to the current schedule.

public Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder TimedKeyFrames<T> (string property, Action<Microsoft.Toolkit.Uwp.UI.Animations.ITimedKeyFrameAnimationBuilder<T>> build, TimeSpan? delay = default, Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption? repeat = default, Windows.UI.Composition.AnimationDelayBehavior? delayBehavior = default, Microsoft.Toolkit.Uwp.UI.Animations.FrameworkLayer layer = Microsoft.Toolkit.Uwp.UI.Animations.FrameworkLayer.Composition) where T : struct;

member this.TimedKeyFrames : string * Action<Microsoft.Toolkit.Uwp.UI.Animations.ITimedKeyFrameAnimationBuilder<'T>> * Nullable<TimeSpan> * Nullable<Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption> * Nullable<Windows.UI.Composition.AnimationDelayBehavior> * Microsoft.Toolkit.Uwp.UI.Animations.FrameworkLayer -> Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder (requires 'T : struct)

Public Function TimedKeyFrames(Of T As Structure) (property As String, build As Action(Of ITimedKeyFrameAnimationBuilder(Of T)), Optional delay As Nullable(Of TimeSpan) = Nothing, Optional repeat As Nullable(Of RepeatOption) = Nothing, Optional delayBehavior As Nullable(Of AnimationDelayBehavior) = Nothing, Optional layer As FrameworkLayer = Microsoft.Toolkit.Uwp.UI.Animations.FrameworkLayer.Composition) As AnimationBuilder

Type Parameters

T

The type of values to animate.

Parameters

property

String

The target property to animate.

build

Action<ITimedKeyFrameAnimationBuilder<T>>

The callback to use to construct the custom animation.

delay

Nullable<TimeSpan>

The optional initial delay for the animation.

repeat

Nullable<RepeatOption>

The repeat option for the animation (defaults to one iteration).

delayBehavior

Nullable<Windows.UI.Composition.AnimationDelayBehavior>

The delay behavior to use (ignored if layer is Xaml).

layer

FrameworkLayer

The target framework layer to animate.

Returns

AnimationBuilder

The current AnimationBuilder instance.