Export (0) Print
Expand All

Frame Class

Updated: February 2009

Frame is a content control that supports navigation.

Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

'Declaration
<LocalizabilityAttribute(LocalizationCategory.Ignore)> _
<ContentPropertyAttribute> _
<TemplatePartAttribute(Name := "PART_FrameCP", Type := GetType(ContentPresenter))> _
Public Class Frame _
	Inherits ContentControl _
	Implements IAddChild, IUriContext
'Usage
Dim instance As Frame
<Frame>
  Content
</Frame>

Frame is a content control that provides the ability to navigate to and display content. Frame can be hosted within other content, as with other controls and elements.

Content can be any type of .NET Framework object and HTML files. In general, however, pages are the preferred the way to package content for navigation (see Page).

Content can be navigated to by setting the Source property with the URI for the desired content. Additionally, content can be navigated to by using one of the following overloads of the Navigate method:

When content is navigated to by URI, Frame returns an object that contains the content. Alternatively, content can be navigated to by using one of the Navigate method overloads that accepts an object:

The lifetime of a navigation can be tracked through the following events:

Not all events are raised each time that a navigation occurs; the set of events that are raised is determined by the type of navigation that occurs (content or content fragment) and how the navigation completes (canceled, stopped, or failed).

The following figure illustrates the sequence in which these events will fire:

Page navigation flow chart

During or after a navigation, Frame provides information about the content that is being navigated to, including the URI of the content being navigated to (Source), the URI of the current content (CurrentSource), and an object that contains the content that was navigated to (Content).

When content is navigated to, Frame records the navigation as an entry in navigation history. An entry is added to back navigation history when either a new navigation occurs, by calling the Navigate method, or by navigating to an entry in forward navigation history, by calling GoForward. An entry is added to forward navigation history by navigating to an entry in back navigation history, by calling GoBack. CanGoBack and CanGoForward report whether there are entries in back and forward navigation history, respectively.

The first time that one piece of content is navigated to from another piece of content, Frame automatically displays a navigation UI that allows users to navigate back and forward through navigation history. You can configure when the navigation UI is shown by setting the NavigationUIVisibility property.

By default, Frame will use its own navigation history only if a parent navigator (NavigationWindow, Frame) with its own navigation history cannot be found. This means that navigation history entries for the frame are mingled with navigation history entries for the parent navigator. To specify that a Frame manages its own navigation history, set the JournalOwnership property to OwnsJournal.

The most recent entry in back navigation history can be removed by calling RemoveBackEntry.

Frame does not store an instance of a content object in navigation history. Instead, Frame creates a new instance of the content object each time it is navigated to by using navigation history. This behavior is designed to avoid excessive memory consumption when large numbers and large pieces of content are being navigated to. Consequently, the state of the content is not remembered from one navigation to the next. However, WPF provides several techniques by which you can store a state for a piece of content in navigation history, which include:

Using AddBackEntry, you can also remember multiple sets of state for a single page instance (see Remember Multiple Sets of State per Page Instance).

Dependency properties for this control might be set by the control’s default style. If a property is set by a default style, the property might change from its default value when the control appears in the application. The default style is determined by which desktop theme is used when the application is running. For more information, see Themes.

The following example shows how to create a simple Frame control and specify initial source content to load from a URI using the Source property.

<Window
    x:Class="XAML.MainWindow"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    Title="XAML" Height="300" Width="300">


...


<Frame Name="islandFrame" Source="IslandFrameContent.xaml" />


...


</Window>

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.DependencyObject
      System.Windows.Media.Visual
        System.Windows.UIElement
          System.Windows.FrameworkElement
            System.Windows.Controls.Control
              System.Windows.Controls.ContentControl
                System.Windows.Controls.Frame

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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

Date

History

Reason

February 2009

Described how default styles change dependency properties.

Customer feedback.

Community Additions

ADD
Show:
© 2014 Microsoft