Article
11/18/2011

Frame Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Represents a control that supports navigation to and from Silverlight pages.

Inheritance Hierarchy

System.Object
  System.Windows.DependencyObject
    System.Windows.UIElement
      System.Windows.FrameworkElement
        System.Windows.Controls.Control
          System.Windows.Controls.ContentControl
            System.Windows.Controls.Frame

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

Syntax

'Declaration
<TemplatePartAttribute(Name := "PrevButton", Type := GetType(ButtonBase))> _
<TemplatePartAttribute(Name := "NextButton", Type := GetType(ButtonBase))> _
Public Class Frame _
    Inherits ContentControl _
    Implements INavigate

[TemplatePartAttribute(Name = "PrevButton", Type = typeof(ButtonBase))]
[TemplatePartAttribute(Name = "NextButton", Type = typeof(ButtonBase))]
public class Frame : ContentControl, INavigate

<sdk:Frame .../>
-or-
<sdk:Frame ...>
  singleUriMapperBase
</sdk:Frame ...>

XAML Values

singleUriMapperBase
An object that facilitates URI mapping.

The Frame type exposes the following members.

Constructors

	Name	Description
	Frame	Initializes a new instance of the Frame class.

Top

Properties

	Name	Description
	ActualHeight	Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
	ActualWidth	Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
	AllowDrop	Gets or sets a value that determines whether this UIElement can be a drop target for purposes of Silverlight drag-and-drop operations. (Inherited from UIElement.)
	Background	Gets or sets a brush that provides the background of the control. (Inherited from Control.)
	BorderBrush	Gets or sets a brush that describes the border background of a control. (Inherited from Control.)
	BorderThickness	Gets or sets the border thickness of a control. (Inherited from Control.)
	CacheMode	Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
	CacheSize	Gets or sets the number of pages that can be cached for the frame.
	CanGoBack	Gets a value that indicates whether there is at least one entry in the back navigation history.
	CanGoForward	Gets a value that indicates whether there is at least one entry in the forward navigation history.
	CharacterSpacing	Gets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from Control.)
	Clip	Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
	Content	Gets or sets the value of the ContentControl dependency property. (Inherited from ContentControl.)
	ContentLoader	Gets or sets the object responsible for providing the content that corresponds to a requested URI.
	ContentTemplate	Gets or sets the data template that is used to display the content of the ContentControl. (Inherited from ContentControl.)
	CurrentSource	Gets the uniform resource identifier (URI) of the content that is currently displayed.
	Cursor	Gets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
	DataContext	Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
	DefaultStyleKey	Gets or sets the key that references the default style for the control. (Inherited from Control.)
	DesiredSize	Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
	Dispatcher	Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
	Effect	Gets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.)
	FlowDirection	Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
	FontFamily	Gets or sets the font used to display text in the control. (Inherited from Control.)
	FontSize	Gets or sets the size of the text in this control. (Inherited from Control.)
	FontStretch	Gets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control.)
	FontStyle	Gets or sets the style in which the text is rendered. (Inherited from Control.)
	FontWeight	Gets or sets the thickness of the specified font. (Inherited from Control.)
	Foreground	Gets or sets a brush that describes the foreground color. (Inherited from Control.)
	Height	Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
	HorizontalAlignment	Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement.)
	HorizontalContentAlignment	Gets or sets the horizontal alignment of the control's content. (Inherited from Control.)
	IsEnabled	Gets or sets a value indicating whether the user can interact with the control. (Inherited from Control.)
	IsHitTestVisible	Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
	IsTabStop	Gets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control.)
	JournalOwnership	Gets or sets whether a frame is responsible for managing its own navigation history, or whether it integrates with the Web browser journal.
	Language	Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
	Margin	Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
	MaxHeight	Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
	MaxWidth	Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
	MinHeight	Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
	MinWidth	Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
	Name	Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement.)
	Opacity	Gets or sets the degree of the object's opacity. (Inherited from UIElement.)
	OpacityMask	Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
	Padding	Gets or sets the padding inside a control. (Inherited from Control.)
	Parent	Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
	Projection	Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
	RenderSize	Gets the final render size of a UIElement. (Inherited from UIElement.)
	RenderTransform	Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
	RenderTransformOrigin	Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.)
	Resources	Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement.)
	Source	Gets or sets the uniform resource identifier (URI) of the current content or the content that is being navigated to.
	Style	Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
	TabIndex	Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key. (Inherited from Control.)
	TabNavigation	Gets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control.)
	Tag	Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
	Template	Gets or sets a control template. (Inherited from Control.)
	Triggers	Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
	UriMapper	Gets or sets the object to manage converting a uniform resource identifier (URI) to another URI for this frame.
	UseLayoutRounding	Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement.)
	VerticalAlignment	Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement.)
	VerticalContentAlignment	Gets or sets the vertical alignment of the control's content. (Inherited from Control.)
	Visibility	Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.)
	Width	Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)

Top

Methods

	Name	Description
	AddHandler	Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.)
	ApplyTemplate	Loads the relevant control template so that its parts can be referenced. (Inherited from Control.)
	Arrange	Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement.)
	ArrangeOverride	Provides the behavior for the Arrange pass of Silverlight layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.)
	CaptureMouse	Sets mouse capture to a UIElement. (Inherited from UIElement.)
	CheckAccess	Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
	ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject.)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	FindName	Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
	Focus	Attempts to set the focus on the control. (Inherited from Control.)
	GetAnimationBaseValue	Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
	GetBindingExpression	Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetTemplateChild	Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
	GoBack	Navigates to the most recent entry in the back navigation history, or throws an exception if no entry exists in back navigation.
	GoForward	Navigates to the most recent entry in the forward navigation history, or throws an exception if no entry exists in forward navigation.
	InvalidateArrange	Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.)
	InvalidateMeasure	Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
	Measure	Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement.)
	MeasureOverride	Provides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Navigate	Navigates to the content specified by the uniform resource identifier (URI).
	OnApplyTemplate	Builds the visual tree for the Frame when a new template is applied. (Overrides FrameworkElement.OnApplyTemplate().)
	OnContentChanged	Called when the value of the Content property changes. (Inherited from ContentControl.)
	OnCreateAutomationPeer	Returns a FrameAutomationPeer for use by the Silverlight automation infrastructure. (Overrides UIElement.OnCreateAutomationPeer().)
	OnDragEnter	Called before the DragEnter event occurs. (Inherited from Control.)
	OnDragLeave	Called before the DragLeave event occurs. (Inherited from Control.)
	OnDragOver	Called before the DragOver event occurs. (Inherited from Control.)
	OnDrop	Called before the Drop event occurs. (Inherited from Control.)
	OnGotFocus	Called before the GotFocus event occurs. (Inherited from Control.)
	OnKeyDown	Called before the KeyDown event occurs. (Inherited from Control.)
	OnKeyUp	Called before the KeyUp event occurs. (Inherited from Control.)
	OnLostFocus	Called before the LostFocus event occurs. (Inherited from Control.)
	OnLostMouseCapture	Called before the LostMouseCapture event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.)
	OnMouseEnter	Called before the MouseEnter event occurs. (Inherited from Control.)
	OnMouseLeave	Called before the MouseLeave event occurs. (Inherited from Control.)
	OnMouseLeftButtonDown	Called before the MouseLeftButtonDown event occurs. (Inherited from Control.)
	OnMouseLeftButtonUp	Called before the MouseLeftButtonUp event occurs. (Inherited from Control.)
	OnMouseMove	Called before the MouseMove event occurs. (Inherited from Control.)
	OnMouseRightButtonDown	Called before the MouseRightButtonDown event occurs. (Inherited from Control.)
	OnMouseRightButtonUp	Called before the MouseRightButtonUp event occurs. (Inherited from Control.)
	OnMouseWheel	Called before the MouseWheel event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.)
	OnTextInput	Called before the TextInput event occurs. (Inherited from Control.)
	OnTextInputStart	Called before the TextInputStart event occurs. (Inherited from Control.)
	OnTextInputUpdate	Called before the TextInputUpdate event occurs. (Inherited from Control.)
	ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
	Refresh	Reloads the current page.
	ReleaseMouseCapture	Removes mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.)
	RemoveHandler	Removes the specified routed event handler from this UIElement. (Inherited from UIElement.)
	SetBinding	Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
	SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
	StopLoading	Stops asynchronous navigations that have not yet been processed.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TransformToVisual	Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
	UpdateLayout	Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)

Top

Events

	Name	Description
	BindingValidationError	Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
	DataContextChanged	Occurs when the data context for this element changes. (Inherited from FrameworkElement.)
	DragEnter	Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.)
	DragLeave	Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.)
	DragOver	Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.)
	Drop	Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.)
	FragmentNavigation	Occurs when navigation to a content fragment begins.
	GotFocus	Occurs when a UIElement receives focus. (Inherited from UIElement.)
	IsEnabledChanged	Occurs when the IsEnabled property changes. (Inherited from Control.)
	KeyDown	Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
	KeyUp	Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
	LayoutUpdated	Occurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.)
	Loaded	Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
	LostFocus	Occurs when a UIElement loses focus. (Inherited from UIElement.)
	LostMouseCapture	Occurs when the UIElement loses mouse capture. (Inherited from UIElement.)
	MediaCommand	Occurs when a button is pressed on a remote control. (Inherited from UIElement.)
	MouseEnter	Occurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.)
	MouseLeave	Occurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.)
	MouseLeftButtonDown	Occurs when the left mouse button is pressed (or when the tip of the stylus touches the tablet) while the mouse pointer is over a UIElement. (Inherited from UIElement.)
	MouseLeftButtonUp	Occurs when the left mouse button is released (or the tip of the stylus is removed from the tablet) while the mouse (or the stylus) is over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
	MouseMove	Occurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
	MouseRightButtonDown	Occurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.)
	MouseRightButtonUp	Occurs when the right mouse button is released while the mouse pointer is over a UIElement. However, this event will only be raised if a caller marks the preceding MouseRightButtonDown event as handled; see Remarks. (Inherited from UIElement.)
	MouseWheel	Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
	Navigated	Occurs when the content that is being navigated to has been found and is available.
	Navigating	Occurs when a new navigation is requested.
	NavigationFailed	Occurs when an error is encountered while navigating to the requested content.
	NavigationStopped	Occurs when a navigation is terminated by either calling the StopLoading method, or when a new navigation is requested while the current navigation is in progress.
	SizeChanged	Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
	TextInput	Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
	TextInputStart	Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
	TextInputUpdate	Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
	Unloaded	Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)

Top

Fields

	Name	Description
	CacheSizeProperty	Identifies the CacheSize dependency property.
	CanGoBackProperty	Identifies the CanGoBack dependency property.
	CanGoForwardProperty	Identifies the CanGoForward dependency property.
	ContentLoaderProperty	Identifies the ContentLoader dependency property.
	CurrentSourceProperty	Identifies the CurrentSource dependency property.
	JournalOwnershipProperty	Identifies the JournalOwnership dependency property.
	SourceProperty	Identifies the Source dependency property.
	UriMapperProperty	Identifies the UriMapper dependency property.

Top

Remarks

You use the Frame control to support navigation to Silverlight Page controls. You create as many different pages as needed to present the content in your application and then navigate to those pages from the frame. When a Uniform Resource Identifier (URI) is requested, either programmatically or through a user action, the frame navigates to the page that matches the URI.

The requested URI can include not only the page to display, but also values that represent a particular state for the page. Within the page, you provide logic to process the URI values and create the page in the correct state.

The frame supports forward and back navigation in the navigation history. Forward and back navigation enables users to conveniently navigate between previously viewed pages and between previously viewed states for a page. You use the GoBack and GoForward methods to launch back and forward navigation requests. A top-level frame (one not nested within another frame) that is hosted in a Web browser can integrate with the browser navigation. You set the JournalOwnership property to specify whether the frame manages its own navigation history, or whether it integrates with the Web browser journal. When integrated with the browser navigation, a user can use the forward and back buttons in the browser to navigate to different states in the Silverlight application.

By default, the frame displays the page that matches the URI request. For example, a request for the URI value /Views/HomePage.xaml means that the frame will display the page located within the application at /Views/HomePage.xaml. However, you can map a particular URI pattern to a file that handles the URI request for that pattern. For example, you can specify that a request for /Home maps to a request for /Views/HomePage.xaml. URI mapping enables you to use user-friendly URIs that do not reflect the exact location of a file in your application.

Through the UriMapper property, you provide a collection of URI patterns that map to Silverlight pages. You define the pattern and the mapped URI by adding a UriMapping object to the UriMappings property of the UriMapper class. You map a matching URI for only the portion of the URI that pertains to navigation within the frame that contains the mappings. For a browser-integrated navigation, the URI is found after the fragment delimiter (#). For example, if your browser-integrated Silverlight application is hosted at https://www.contoso.com/Default.aspx, you specify a matching URI for https://www.contoso.com/Default.aspx\#/Home by creating an instance of UriMapping that only matches /Home. For applications that are not integrated with a browser, the URI will also be /Home.

The URI pattern you specify does not have to be the exact URI to match against the requested URI. The pattern can include placeholder segments in the URI that will match any value in that segment. You specify a placeholder segment by enclosing the name of the segment with the curly braces ( { and } ). These placeholder segments act as variables when mapping to the URI. For example, in the App.xaml file, you can specify the following UriMapping instance:

<sdk:UriMapping Uri="Products/{type}" 
  MappedUri="/Views/ProductDetail.xaml?producttype={type}">
</sdk:UriMapping>

The pattern Products/{type} will match any request that includes Products followed by a segment. The matching URIs could include Products/bikes, Products/kitchen or any other similar request. The value specified in the second segment is included in the query string of the mapped URI where the matching {type} value is defined.

You set the CacheSize property to specify how many pages can be retained in a cache. When a page is cached, an instance of the page is reused for each navigation request instead of re-creating the page for each request. To cache a page, you must also set the NavigationCacheMode property of the Page class to either Enabled or Required. When a page's NavigationCacheMode property is set to Required the page is cached regardless of the number of cached pages specified in the CacheSize property. Pages marked as Required do not count against the CacheSize total.

Note:
The Frame control is available as part of the libraries in the Silverlight Software Development Kit (SDK). For more information, see the Silverlight Tools.

Examples

The following example shows the XAML for a frame that includes URI mapping definitions. The frame will navigate to the value of its Source property, which in this example is set by default to /Home.

<sdk:Frame 
       x:Name="ContentFrame" 
       Style="{StaticResource ContentFrameStyle}" 
       Source="/Home" 
       Navigated="ContentFrame_Navigated" 
       NavigationFailed="ContentFrame_NavigationFailed">
    <sdk:Frame.UriMapper>
        <sdk:UriMapper>
            <sdk:UriMapping 
                Uri="/ProductDetail/{productid}" 
                MappedUri="/Views/ProductDetail.xaml?ProductId={productid}"/>
            <sdk:UriMapping 
                Uri="/Reports/{type}/{selection}" 
                MappedUri="/Views/ReportsPage.xaml?type={type}&amp;selection={selection}"/>
            <sdk:UriMapping 
                Uri="/{pageName}" 
                MappedUri="/Views/{pageName}.xaml"/>
        </sdk:UriMapper>
    </sdk:Frame.UriMapper>
</sdk:Frame>

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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

Partager via