PageStackEntry PageStackEntry PageStackEntry PageStackEntry Class

Definition

Represents an entry in the BackStack or ForwardStack of a Frame.

public : sealed class PageStackEntry : DependencyObject, IPageStackEntry
struct winrt::Windows::UI::Xaml::Navigation::PageStackEntry : DependencyObject, IPageStackEntry
public sealed class PageStackEntry : DependencyObject, IPageStackEntry
Public NotInheritable Class PageStackEntry Inherits DependencyObject Implements IPageStackEntry
Inheritance
PageStackEntryPageStackEntryPageStackEntryPageStackEntry
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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) PageStackEntry(TypeName, Object, NavigationTransitionInfo) PageStackEntry(TypeName, Object, NavigationTransitionInfo) PageStackEntry(TypeName, Object, NavigationTransitionInfo)

Initializes a new instance of the PageStackEntry class.

public : PageStackEntry(TypeName sourcePageType, Platform::Object parameter, NavigationTransitionInfo navigationTransitionInfo)
PageStackEntry(TypeName sourcePageType, winrt::Windows::Foundation::IInspectable parameter, NavigationTransitionInfo navigationTransitionInfo) const;
public PageStackEntry(Type sourcePageType, Object parameter, NavigationTransitionInfo navigationTransitionInfo)
Public Sub New(sourcePageType As Type, parameter As Object, navigationTransitionInfo As NavigationTransitionInfo)
Parameters
sourcePageType
Type Type

The type of page associated with the navigation entry, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)).

parameter
Object Object

The navigation parameter associated with the navigation entry.

navigationTransitionInfo
NavigationTransitionInfo NavigationTransitionInfo

Info about the animated transition associated with the navigation entry.

Remarks

Note

If you are programming using a Microsoft .NET language (C# or Microsoft Visual Basic), the TypeName type projects as System.Type. When programming using C#, it is common to use the typeof operator to get references to the System.Type of a type. In Microsoft Visual Basic, use GetType. If you're using Visual C++ component extensions (C++/CX)), where you'll need to create a TypeName helper struct, you can use the typeid component extension.

See Also

Properties

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

NavigationTransitionInfo NavigationTransitionInfo NavigationTransitionInfo NavigationTransitionInfo

Gets a value that indicates the animated transition associated with the navigation entry.

public : NavigationTransitionInfo NavigationTransitionInfo { get; }
NavigationTransitionInfo NavigationTransitionInfo();
public NavigationTransitionInfo NavigationTransitionInfo { get; }
Public ReadOnly Property NavigationTransitionInfo As NavigationTransitionInfo
Value
NavigationTransitionInfo NavigationTransitionInfo

Info about the animated transition.

Parameter Parameter Parameter Parameter

Gets the navigation parameter associated with this navigation entry.

public : Platform::Object Parameter { get; }
winrt::Windows::Foundation::IInspectable Parameter();
public object Parameter { get; }
Public ReadOnly Property Parameter As object
Value
object object

The navigation parameter.

SourcePageType SourcePageType SourcePageType SourcePageType

Gets the type of page associated with this navigation entry.

public : TypeName SourcePageType { get; }
TypeName SourcePageType();
public Type SourcePageType { get; }
Public ReadOnly Property SourcePageType As Type
Value
Type Type

The page type of the navigation entry, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)).

Remarks

Note

If you are programming using a Microsoft .NET language (C# or Microsoft Visual Basic), the TypeName type projects as System.Type. If you're using Visual C++ component extensions (C++/CX)), this is a TypeName helper struct.

See Also

SourcePageTypeProperty SourcePageTypeProperty SourcePageTypeProperty SourcePageTypeProperty

Identifies the SourcePageType dependency property.

public : static DependencyProperty SourcePageTypeProperty { get; }
static DependencyProperty SourcePageTypeProperty();
public static DependencyProperty SourcePageTypeProperty { get; }
Public Static ReadOnly Property SourcePageTypeProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the SourcePageType dependency property.

Methods

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Clears the local value of a dependency property.

(Inherited from DependencyObject)

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) 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) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

(Inherited from DependencyObject)

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

(Inherited from DependencyObject)

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) 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) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Sets the local value of a dependency property on a DependencyObject.

(Inherited from DependencyObject)

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

(Inherited from DependencyObject)

See Also