ConnectedAnimation Class

Reference

Definition

Namespace:: Microsoft.UI.Xaml.Media.Animation

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents an animation that simultaneously animates the exit of one element and the entrance of another element.

public ref class ConnectedAnimation sealed

/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ConnectedAnimation final

[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ConnectedAnimation

Public NotInheritable Class ConnectedAnimation

Inheritance: Object Platform::Object IInspectable ConnectedAnimation

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Examples

Tip

For more info, design guidance, and code examples, see Connected animation.

Open the WinUI 3 Gallery app and see ConnectedAnimation in action.

The WinUI 3 Gallery app includes interactive examples of most WinUI 3 controls, features, and functionality. Get the app from the Microsoft Store or get the source code on GitHub.

Remarks

A ConnectedAnimation instance is returned by the ConnectedAnimationService.GetAnimation and ConnectedAnimationService.PrepareToAnimate methods.

When you call TryStart, the element you pass into the method should have its size defined in layout. This means that either the size of the element should be set in markup, or the content of the element should be fully populated, so that its size can be calculated by the XAML framework. If the layout is part of a ListView or GridView item with bound properties, you might have to manually update the content to prepare for the animation because bindings can be updated asynchronously.

There is a known limitation where ConnectedAnimation does not work well with theme transitions that have a translation component, including NavigationThemeTransition and EntranceThemeTransition. We recommend that you remove these transitions, or suppress the navigation using SuppressNavigationTransitionInfo, when you create an experience with ConnectedAnimation.

See the Connected animation sample for a complete example of ConnectedAnimation.

Properties

Configuration	Gets or sets the configuration that describes the type of connected animation to play.
IsScaleAnimationEnabled	Gets or sets a value that indicates whether the scale component of the connected animation should be used.

Methods

Cancel()	Stops the connected animation.
SetAnimationComponent(ConnectedAnimationComponent, ICompositionAnimationBase)	Sets a custom CompositionAnimation to change the motion of a particular part of the connected animation.
TryStart(UIElement, IIterable<UIElement>)	Attempts to start the animation on the destination element and specified secondary elements.
TryStart(UIElement)	Attempts to start the animation.

Events

Completed

Occurs when the animation is finished.

Applies to

Share via