Frame.GetNavigationState method

Applies to Windows and Windows Phone

Serializes the Frame navigation history into a string.

Syntax


Public Function GetNavigationState() As String

Parameters

This method has no parameters.

Return value

Type: System.String [.NET] | Platform::String [C++]

The string-form serialized navigation history. See Remarks.

Remarks

This method is useful to restore the navigation state of your app after it has been suspended and resumed. When your app is suspended, call GetNavigationState and save the return value. When your app is resumed, call SetNavigationState and pass it the saved value.

Calling this method will call Page.OnNavigatedFrom for the current page using NavigationMode.Forward. GetNavigationState is usually called when the application is being suspended, so the current page is navigated away from.

Note  The serialization format used by these methods is for internal use only. Your app should not form any dependencies on it. Additionally, this format supports serialization only for basic types like string, char, numeric and GUID types.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Controls
Windows::UI::Xaml::Controls [C++]

Metadata

Windows.winmd

See also

Frame
SetNavigationState

 

 

Show:
© 2014 Microsoft