Share via


AnimationExtensions.AbortAnimation(IAnimatable, String) Method

Definition

Stops the animation.

public static bool AbortAnimation (this Xamarin.Forms.IAnimatable self, string handle);
static member AbortAnimation : Xamarin.Forms.IAnimatable * string -> bool

Parameters

self
IAnimatable

The object on which this method will be run.

handle
System.String

An animation key that must be unique among its sibling and parent animations for the duration of the animation.

Returns

System.Boolean

Remarks

If handle refers to an animation that belongs to this IAnimatable instance, then its tweener handlers are removed, the tweener is stopped, the animation is removed from this IAnimatable instance, and it is marked as finished. If handle refers to one of the kinetics that belong to this IAnimatable instance, then it and its ticker are removed.

Applies to