CommonNavigationTransitionInfo Class

Definition

Provides common parameters for navigation transition animations.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.Animation.CommonNavigationTransitionInfo (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

public ref class CommonNavigationTransitionInfo sealed : NavigationTransitionInfo
/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class CommonNavigationTransitionInfo final : NavigationTransitionInfo
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class CommonNavigationTransitionInfo final : NavigationTransitionInfo
[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class CommonNavigationTransitionInfo : NavigationTransitionInfo
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class CommonNavigationTransitionInfo : NavigationTransitionInfo
Public NotInheritable Class CommonNavigationTransitionInfo
Inherits NavigationTransitionInfo
<NavigationThemeTransition>
  <CommonNavigationTransitionInfo ... />
</NavigationThemeTransition>
Inheritance
Object IInspectable DependencyObject NavigationTransitionInfo CommonNavigationTransitionInfo
Attributes

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

XAML attached properties

CommonNavigationTransitionInfo is the host service class for a XAML attached property.

In order to support XAML processor access to the attached properties, and also to expose equivalent get and set operations to code, each XAML attached property has a pair of Get and Set accessor methods. Another way to get or set the value in code is to use the dependency property system, calling either GetValue or SetValue and passing the identifier field as the dependency property identifier.

Attached property Description
IsStaggerElement Gets or sets a value that indicates whether this element is the stagger element for the navigation transition.

Constructors

CommonNavigationTransitionInfo()

Initializes a new instance of the CommonNavigationTransitionInfo class.

Properties

Dispatcher

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher 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)
IsStaggerElementProperty

Identifies the CommonNavigationTransitionInfo.IsStaggerElement attached property.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.Animation.CommonNavigationTransitionInfo.IsStaggerElementProperty (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

IsStaggeringEnabled

Gets or sets a Boolean value indicating if staggering is enabled for the navigation transition.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.Animation.CommonNavigationTransitionInfo.IsStaggeringEnabled (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

IsStaggeringEnabledProperty

Identifies the IsStaggeringEnabled dependency property.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.Animation.CommonNavigationTransitionInfo.IsStaggeringEnabledProperty (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Attached Properties

IsStaggerElement

Gets or sets a value that indicates whether this element is the stagger element for the navigation transition.

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)
GetIsStaggerElement(UIElement)

Returns a Boolean value indicating if the specified UIElement is the stagger element for the navigation transition.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.Animation.CommonNavigationTransitionInfo.GetIsStaggerElement (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

GetNavigationStateCore()

When implemented in a derived class, gets the navigation state string that is reported for navigation actions through Frame.Navigate and similar API.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.Animation.NavigationTransitionInfo.GetNavigationStateCore (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

(Inherited from NavigationTransitionInfo)
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)
SetIsStaggerElement(UIElement, Boolean)

Sets a Boolean value indicating if the specified UIElement is the stagger element for the navigation transition.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.Animation.CommonNavigationTransitionInfo.SetIsStaggerElement (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

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.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.Animation.NavigationTransitionInfo.SetNavigationStateCore (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

(Inherited from NavigationTransitionInfo)
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

See also