PageStackEntry Class

Reference

Definition

Namespace:: Microsoft.UI.Xaml.Navigation

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 entry in the BackStack or ForwardStack of a Frame.

public ref class PageStackEntry sealed : DependencyObject

/// [Windows.Foundation.Metadata.Activatable(Microsoft.UI.Xaml.Navigation.IPageStackEntryFactory, 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 PageStackEntry final : DependencyObject

[Windows.Foundation.Metadata.Activatable(typeof(Microsoft.UI.Xaml.Navigation.IPageStackEntryFactory), 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 PageStackEntry : DependencyObject

Public NotInheritable Class PageStackEntry
Inherits DependencyObject

Inheritance: Object Platform::Object IInspectable DependencyObject PageStackEntry

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Remarks

This class contains info about a specific navigation in the history of a Frame. It typically represents entries in the BackStack and ForwardStack as a result of previous Frame navigations. You can also use this class to add new entries to the navigation history for special purposes. For example, when the user navigates to a specific page using a secondary tile, you can add an entry for the app's main page to the BackStack. This will enable the back button on the secondary tile's page so that the user can easily navigate from there to the home page.

Constructors

PageStackEntry(TypeName, Object, NavigationTransitionInfo)

Initializes a new instance of the PageStackEntry 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)
NavigationTransitionInfo	Gets a value that indicates the animated transition associated with the navigation entry.
Parameter	Gets the navigation parameter associated with this navigation entry.
SourcePageType	Gets the type of page associated with this navigation entry.
SourcePageTypeProperty	Identifies the SourcePageType dependency property.

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)
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)
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

Share via