CommonNavigationTransitionInfo Class

Definition

Namespace:

Microsoft.UI.Xaml.Media.Animation

Provides common parameters for navigation transition animations.

public ref class CommonNavigationTransitionInfo sealed : NavigationTransitionInfo

/// [Windows.Foundation.Metadata.Activatable(65536, "Microsoft.UI.Xaml.WinUIContract")]
/// [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 CommonNavigationTransitionInfo final : NavigationTransitionInfo

[Windows.Foundation.Metadata.Activatable(65536, "Microsoft.UI.Xaml.WinUIContract")]
[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 sealed class CommonNavigationTransitionInfo : NavigationTransitionInfo

Public NotInheritable Class CommonNavigationTransitionInfo
Inherits NavigationTransitionInfo

<NavigationThemeTransition>
  <CommonNavigationTransitionInfo ... />
</NavigationThemeTransition>

Inheritance

Object Platform::Object IInspectable DependencyObject NavigationTransitionInfo CommonNavigationTransitionInfo

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

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. Type: Boolean Identifier field: IsStaggerElementProperty Accessor methods: GetIsStaggerElement, SetIsStaggerElement

Constructors

CommonNavigationTransitionInfo()

Initializes a new instance of the CommonNavigationTransitionInfo 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)
IsStaggerElementProperty	Identifies the CommonNavigationTransitionInfo.IsStaggerElement attached property.
IsStaggeringEnabled	Gets or sets a Boolean value indicating if staggering is enabled for the navigation transition.
IsStaggeringEnabledProperty	Identifies the IsStaggeringEnabled dependency property.

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.
GetNavigationStateCore()	When implemented in a derived class, gets the navigation state string that is reported for navigation actions through Frame.Navigate and similar API. (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.
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. (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)

See also

• NavigationTransitionInfo