NavigationTransitionInfo 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

Provides parameter info for the Frame.Navigate method. Controls how the transition animation runs during the navigation action.

public ref class NavigationTransitionInfo : DependencyObject

/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class NavigationTransitionInfo : DependencyObject

[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class NavigationTransitionInfo : DependencyObject

Public Class NavigationTransitionInfo
Inherits DependencyObject

Inheritance: Object Platform::Object IInspectable DependencyObject NavigationTransitionInfo

Derived: Microsoft.UI.Xaml.Media.Animation.CommonNavigationTransitionInfo

Microsoft.UI.Xaml.Media.Animation.ContinuumNavigationTransitionInfo

Microsoft.UI.Xaml.Media.Animation.DrillInNavigationTransitionInfo

Microsoft.UI.Xaml.Media.Animation.EntranceNavigationTransitionInfo

Microsoft.UI.Xaml.Media.Animation.SlideNavigationTransitionInfo

More…

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Examples

<Frame x:Name="myFrame">
    <Frame.ContentTransitions>
        <TransitionCollection>
            <NavigationThemeTransition />
        </TransitionCollection>
    </Frame.ContentTransitions>
</Frame>

// Play the default animation.
myFrame.Navigate(typeof(Page2), null);

// Explicitly play the page refresh animation.
myFrame.Navigate(typeof(Page2), null, new EntranceNavigationTransitionInfo());

// Play the drill in animation.
myFrame.Navigate(typeof(Page2), null, new DrillInNavigationTransitionInfo());

// Suppress the default animation.
myFrame.Navigate(typeof(Page2), null, new SuppressNavigationTransitionInfo());

Remarks

Navigation transition animations can be any of the *TransitionInfo types. We recommend using the following page transitions:

Constructors

NavigationTransitionInfo()

Initializes a new instance of the NavigationTransitionInfo class.

Properties

Dispatcher	Always returns `null` in a Windows App SDK app. Use DispatcherQueue instead. (Inherited from DependencyObject)
DispatcherQueue	Gets the `DispatcherQueue` that this object is associated with. The `DispatcherQueue` represents a facility that can access the `DependencyObject` on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject)

Methods

ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
GetAnimationBaseValue(DependencyProperty)	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetNavigationStateCore()	When implemented in a derived class, gets the navigation state string that is reported for navigation actions through Frame.Navigate and similar API.
GetValue(DependencyProperty)	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject)
SetNavigationStateCore(String)	When implemented in a derived class, sets the navigation state string that is passed for navigation actions through Frame.Navigate and similar API.
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)

Applies to