AnimationExtensions.AbortAnimation(IAnimatable, String) Method

Definition

Namespace:

Microsoft.Maui.Controls

Assembly:

Microsoft.Maui.Controls.dll

Source:

AnimationExtensions.cs

Stops the animation.

public:
[System::Runtime::CompilerServices::Extension]
 static bool AbortAnimation(Microsoft::Maui::Controls::IAnimatable ^ self, System::String ^ handle);

public static bool AbortAnimation (this Microsoft.Maui.Controls.IAnimatable self, string handle);

static member AbortAnimation : Microsoft.Maui.Controls.IAnimatable * string -> bool

<Extension()>
Public Function AbortAnimation (self As IAnimatable, handle As String) As Boolean

Parameters

self

IAnimatable

The object on which this method will be run.

handle

String

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

Returns

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.