IProvideCustomContentState Interface

Implemented by a class that needs to add custom state to the navigation history entry for content before the content is navigated away from.

Namespace:  System.Windows.Navigation
Assembly:  PresentationFramework (in PresentationFramework.dll)

public interface IProvideCustomContentState
Interfaces cannot be used directly in XAML; see types that implement this interface.

IProvideCustomContentState allows you to associate a piece of custom state, implemented as a custom CustomContentState class, with the navigation history entry for content that has been navigated away from.

Custom state can also be associated in this way by using the following:

You must implement IProvideCustomContentState when you add custom state to navigation history by calling AddBackEntry, otherwise navigation history will not function correctly; consider the following steps:

  1. AddBackEntry is called to associate a custom state with the current content.

  2. The navigation history entry is navigated back to, and the Replay method of the custom state is called, and the state is applied to the content.

  3. The previous content is navigated to in forward navigation history.

  4. The navigation history entry is navigated back to, but the custom state has not been retained since the last time the navigation history entry it was associated with was navigated to.

This is the default behavior because the state that is initially recorded in custom state may change after it was added to navigation history. If the custom state object is navigated back to and its state is applied, before some aspect about the state changes before the entry in navigation history is navigated to, the change in state cannot be reflected in the custom state object. Furthermore, AddBackEntry can't be explicitly called to add a new custom state object that reflects the state changes. Consequently, to ensure the current state for a particular navigation is always stored in navigation history, GetContentState is called.

For an example that uses IProvideCustomContentState to remember a single set of state across page instances, see Remember a Single Set of State Across Page Instances.

For an example that uses IProvideCustomContentState to remember multiple sets of state for a single page instance, see Remember Multiple Sets of State per Page Instance.

Important noteImportant Note:

When you store information in custom content state, you cannot store any references to the instance of the page for which you are remembering state. This prevents WPF from releasing the page instance, and defeats the purpose of the default navigation history behavior. If you must do this, you might consider using KeepAlive instead.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft