AnimationBuilder.Clip 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

Clip(Side)	Adds a new clip animation to the current schedule.
Clip(Thickness, Nullable<Thickness>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<RepeatOption>, EasingType, EasingMode)	Adds a new clip animation to the current schedule.
Clip(Side, Double, Nullable<Double>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<RepeatOption>, EasingType, EasingMode)	Adds a new clip animation to the current schedule.

Clip(Side)

Adds a new clip animation to the current schedule.

public Microsoft.Toolkit.Uwp.UI.Animations.IPropertyAnimationBuilder<double> Clip (Microsoft.Toolkit.Uwp.UI.Animations.Side side);

member this.Clip : Microsoft.Toolkit.Uwp.UI.Animations.Side -> Microsoft.Toolkit.Uwp.UI.Animations.IPropertyAnimationBuilder<double>

Public Function Clip (side As Side) As IPropertyAnimationBuilder(Of Double)

Parameters

side

Side

The clip size to animate.

Returns

IPropertyAnimationBuilder<Double>

An IPropertyAnimationBuilder<T> instance to configure the animation.

Remarks

This animation is only available on the composition layer.

Clip(Thickness, Nullable<Thickness>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<RepeatOption>, EasingType, EasingMode)

Adds a new clip animation to the current schedule.

public Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder Clip (Windows.UI.Xaml.Thickness to, Windows.UI.Xaml.Thickness? from = default, TimeSpan? delay = default, TimeSpan? duration = default, Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption? repeat = default, Microsoft.Toolkit.Uwp.UI.Animations.EasingType easingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Windows.UI.Xaml.Media.Animation.EasingMode easingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseInOut);

member this.Clip : Windows.UI.Xaml.Thickness * Nullable<Windows.UI.Xaml.Thickness> * Nullable<TimeSpan> * Nullable<TimeSpan> * Nullable<Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption> * Microsoft.Toolkit.Uwp.UI.Animations.EasingType * Windows.UI.Xaml.Media.Animation.EasingMode -> Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder

Public Function Clip (to As Thickness, Optional from As Nullable(Of Thickness) = Nothing, Optional delay As Nullable(Of TimeSpan) = Nothing, Optional duration As Nullable(Of TimeSpan) = Nothing, Optional repeat As Nullable(Of RepeatOption) = Nothing, Optional easingType As EasingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Optional easingMode As EasingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseInOut) As AnimationBuilder

Parameters

to

Thickness

The final value for the animation.

from

Nullable<Thickness>

The optional starting value for the animation.

delay

Nullable<TimeSpan>

The optional initial delay for the animation.

duration

Nullable<TimeSpan>

The optional animation duration.

repeat

Nullable<RepeatOption>

The optional repeat mode (defaults to once).

easingType

EasingType

The optional easing function type for the animation.

easingMode

Windows.UI.Xaml.Media.Animation.EasingMode

The optional easing function mode for the animation.

Returns

AnimationBuilder

The current AnimationBuilder instance.

Remarks

This animation is only available on the composition layer.

Clip(Side, Double, Nullable<Double>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<RepeatOption>, EasingType, EasingMode)

Adds a new clip animation to the current schedule.

public Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder Clip (Microsoft.Toolkit.Uwp.UI.Animations.Side side, double to, double? from = default, TimeSpan? delay = default, TimeSpan? duration = default, Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption? repeat = default, Microsoft.Toolkit.Uwp.UI.Animations.EasingType easingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Windows.UI.Xaml.Media.Animation.EasingMode easingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseInOut);

member this.Clip : Microsoft.Toolkit.Uwp.UI.Animations.Side * double * Nullable<double> * Nullable<TimeSpan> * Nullable<TimeSpan> * Nullable<Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption> * Microsoft.Toolkit.Uwp.UI.Animations.EasingType * Windows.UI.Xaml.Media.Animation.EasingMode -> Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder

Public Function Clip (side As Side, to As Double, Optional from As Nullable(Of Double) = Nothing, Optional delay As Nullable(Of TimeSpan) = Nothing, Optional duration As Nullable(Of TimeSpan) = Nothing, Optional repeat As Nullable(Of RepeatOption) = Nothing, Optional easingType As EasingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Optional easingMode As EasingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseInOut) As AnimationBuilder

Parameters

side

Side

The clip size to animate.

to

Double

The final value for the animation.

from

Nullable<Double>

The optional starting value for the animation.

delay

Nullable<TimeSpan>

The optional initial delay for the animation.

duration

Nullable<TimeSpan>

The optional animation duration.

repeat

Nullable<RepeatOption>

The optional repeat mode (defaults to once).

easingType

EasingType

The optional easing function type for the animation.

easingMode

Windows.UI.Xaml.Media.Animation.EasingMode

The optional easing function mode for the animation.

Returns

AnimationBuilder

The current AnimationBuilder instance.

Remarks

This animation is only available on the composition layer.