Frame.SetNavigationState メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
SetNavigationState(String) |
指定されたシリアル化文字列から Frame のナビゲーション履歴を読み取って復元します。 |
SetNavigationState(String, Boolean) |
指定されたシリアル化文字列から Frame のナビゲーション履歴を読み取って復元します。 |
SetNavigationState(String)
public:
virtual void SetNavigationState(Platform::String ^ navigationState) = SetNavigationState;
/// [Windows.Foundation.Metadata.Overload("SetNavigationState")]
void SetNavigationState(winrt::hstring const& navigationState);
[Windows.Foundation.Metadata.Overload("SetNavigationState")]
public void SetNavigationState(string navigationState);
function setNavigationState(navigationState)
Public Sub SetNavigationState (navigationState As String)
パラメーター
- navigationState
-
String
Platform::String
winrt::hstring
ナビゲーション履歴の復元ポイントを提供するシリアル化文字列。
- 属性
注釈
このメソッドは、アプリのナビゲーション状態を保存および復元するのに役立ちます。 ナビゲーション状態を保存するには、 GetNavigationState を 呼び出し、戻り値を保存します。 ナビゲーション状態を復元するには、 を呼び出 SetNavigationState
し、保存された値を渡します。
を呼び出すと SetNavigationState
、現在の ページの Page.OnNavigatedTo が と NavigationMode.Back
呼び出されます。
SetNavigationState
は通常、ウィンドウがアクティブ化されるときに呼び出されるため、現在のページに移動します。
ヒント
UWP アプリでは、 は通常、 GetNavigationState
アプリが中断されたときに呼び出され SetNavigationState
、アプリが再開されたときに呼び出されます。 中断後にアプリが再開されると、ユーザーはアプリが同じ状態であると想定します。
Windows アプリ SDK アプリには Suspending
イベントと Resuming
イベントがないため、 が閉じられ、アクティブ化されたときにWindow
、アプリがナビゲーション状態を保存および復元するのに適しているかどうかを検討する必要があります。 ユーザーは、 を閉じた Window
後にナビゲーション状態が復元されるとは思わない場合があります。 詳細については、「アプリのライフサイクルWindows アプリ SDK」を参照してください。
適用対象
SetNavigationState(String, Boolean)
public:
virtual void SetNavigationState(Platform::String ^ navigationState, bool suppressNavigate) = SetNavigationState;
/// [Windows.Foundation.Metadata.Overload("SetNavigationStateWithNavigationControl")]
void SetNavigationState(winrt::hstring const& navigationState, bool const& suppressNavigate);
[Windows.Foundation.Metadata.Overload("SetNavigationStateWithNavigationControl")]
public void SetNavigationState(string navigationState, bool suppressNavigate);
function setNavigationState(navigationState, suppressNavigate)
Public Sub SetNavigationState (navigationState As String, suppressNavigate As Boolean)
パラメーター
- navigationState
-
String
Platform::String
winrt::hstring
ナビゲーション履歴の復元ポイントを提供するシリアル化文字列。
- suppressNavigate
-
Boolean
bool
true
現在のページに移動せずにナビゲーション履歴を復元する場合。それ以外の場合は false
。
- 属性
注釈
パラメーターを に設定して true
をsuppressNavigate
呼び出SetNavigationState
した場合、現在のページに対して Page.OnNavigatedTo は呼び出されません。 現在のページも BackStack に配置されます。 切り替えを抑制する場合は、 GoBack または GoForward を使用して、ナビゲーション履歴の正しいページに移動してください。
NavigateToType もサポートされていますが、前方スタックを使用するとクリアされます。