ConnectedAnimationService.PrepareToAnimate(String, UIElement) Method

Definition

Namespace:

Windows.UI.Xaml.Media.Animation

Returns a connected animation that's associated with the specified key and source element.

public:
 virtual ConnectedAnimation ^ PrepareToAnimate(Platform::String ^ key, UIElement ^ source) = PrepareToAnimate;

ConnectedAnimation PrepareToAnimate(winrt::hstring const& key, UIElement const& source);

public ConnectedAnimation PrepareToAnimate(string key, UIElement source);

function prepareToAnimate(key, source)

Public Function PrepareToAnimate (key As String, source As UIElement) As ConnectedAnimation

Parameters

key

String

Platform::String

winrt::hstring

The key for the animation.

source

UIElement

The element that is animated out of view.

Returns

ConnectedAnimation

The animation with the specified key.

Remarks

When you call PrepareToAnimate, you supply a key to associate with the newly created ConnectedAnimation returned by the method. You can later use this key to retrieve the same animation by calling GetAnimation. This lets you connect the animation between two different pages without having to manually pass the reference to the ConnectedAnimation object between pages.