PhoneApplicationFrame Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

The class for the PhoneApplicationFrame control for Windows Phone projects. For more information about this control, see In-app navigation for Windows Phone 8.

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
Microsoft.Phone.Controls..::.PhoneApplicationFrame

Namespace: Microsoft.Phone.Controls
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)
XMLNS for XAML: Not mapped to an xmlns.

Syntax

<TemplatePartAttribute(Name := "ClientArea", Type := GetType(FrameworkElement))> _
Public Class PhoneApplicationFrame _
    Inherits Frame
[TemplatePartAttribute(Name = "ClientArea", Type = typeof(FrameworkElement))]
public class PhoneApplicationFrame : Frame
<PhoneApplicationFrame>
  Content
</PhoneApplicationFrame>

The PhoneApplicationFrame type exposes the following members.

Constructors

Name Description
PhoneApplicationFrame Initializes a new instance of the PhoneApplicationFrame 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 drag-and-drop operations. (Inherited from UIElement.)
Background (Inherited from Control.)
BackStack Gets an IEnumerable that you use to enumerate the entries in the back navigation history.
BorderBrush (Inherited from Control.)
BorderThickness (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. (Inherited from Frame.)
CanGoBack Gets a value that indicates whether there is at least one entry in the back navigation history. (Inherited from Frame.)
CanGoForward Gets a value that indicates whether there is at least one entry in the forward navigation history. (Inherited from Frame.)
CharacterSpacing (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.)
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. (Inherited from Frame.)
Cursor Infrastructure. Gets or sets the cursor image that displays while the 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 (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.)
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 (Inherited from Control.)
FontSize (Inherited from Control.)
FontStretch (Inherited from Control.)
FontStyle (Inherited from Control.)
FontWeight (Inherited from Control.)
Foreground (Inherited from Control.)
FullScreen Gets or sets a value that indicates whether the phone application frame is in full-screen mode or normal window mode.
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 (Inherited from Control.)
IsEnabled (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 (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. (Inherited from Frame.)
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.)
Orientation This property indicates the current orientation of the frame that is decided by the hosted page.
Padding (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. (Inherited from Frame.)
Style Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
TabIndex (Inherited from Control.)
TabNavigation (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 (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. (Inherited from 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.)
UseOptimizedManipulationRouting Gets or sets a value that indicates whether the system should handle input events or whether the FrameworkElement should handle input events. (Inherited from FrameworkElement.)
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 (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 (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 When overridden in a derived class, positions child elements and determines a size for a FrameworkElement derived class. (Overrides FrameworkElement..::.ArrangeOverride(Size).)
CaptureMouse Sets touch 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 attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. Finalize is protected and, therefore, is accessible only through this class or a derived class. (Overrides Object..::.Finalize()()().)
FindName Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
Focus (Inherited from Control.)
GetAnimationBaseValue Returns any base value established for a Windows Phone 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 (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. (Inherited from Frame.)
GoForward Navigates to the most recent entry in the forward navigation history, or throws an exception if no entry exists in forward navigation. For Windows Phone, this method will always throw an exception because there is no forward navigation stack. (Inherited from Frame.)
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 When overridden in a derived class, measures the size in layout required for child elements and determines a size for the FrameworkElement-derived class. (Overrides FrameworkElement..::.MeasureOverride(Size).)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Navigate Navigates to the content specified by the uniform resource identifier (URI). (Inherited from Frame.)
OnApplyTemplate This method applies a template to the PhoneApplicationFrame. (Overrides Frame..::.OnApplyTemplate()()().)
OnContentChanged Called when the value of the Content property changes. (Inherited from ContentControl.)
OnCreateAutomationPeer Returns a FrameAutomationPeer for use by the Windows Phone automation infrastructure. (Overrides UIElement OnCreateAutomationPeer().) (Inherited from Frame.)
OnDoubleTap (Inherited from Control.)
OnDragEnter (Inherited from Control.)
OnDragLeave (Inherited from Control.)
OnDragOver (Inherited from Control.)
OnDrop (Inherited from Control.)
OnGotFocus (Inherited from Control.)
OnHold (Inherited from Control.)
OnKeyDown (Inherited from Control.)
OnKeyUp (Inherited from Control.)
OnLostFocus (Inherited from Control.)
OnLostMouseCapture (Inherited from Control.)
OnManipulationCompleted (Inherited from Control.)
OnManipulationDelta (Inherited from Control.)
OnManipulationStarted (Inherited from Control.)
OnMouseEnter (Inherited from Control.)
OnMouseLeave (Inherited from Control.)
OnMouseLeftButtonDown (Inherited from Control.)
OnMouseLeftButtonUp (Inherited from Control.)
OnMouseMove (Inherited from Control.)
OnMouseRightButtonDown (Inherited from Control.)
OnMouseRightButtonUp (Inherited from Control.)
OnMouseWheel (Inherited from Control.)
OnTap (Inherited from Control.)
OnTextInput (Inherited from Control.)
OnTextInputStart (Inherited from Control.)
OnTextInputUpdate (Inherited from Control.)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
ReleaseMouseCapture Removes touch capture from a UIElement. After this call, typically no object holds touch capture. (Inherited from UIElement.)
RemoveBackEntry This method is used to remove the most recent entry from the back stack, or throws an InvalidOperationException if there are no more entries to remove. If you want to remove more than one item, you call this method multiple times. This API is synchronous and must be called from the UI thread.
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. (Inherited from Frame.)
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
BackKeyPress Occurs when the hardware Back button is pressed.
BindingValidationError Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
DoubleTap Occurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
FragmentNavigation Occurs when navigation to a content fragment begins. (Inherited from Frame.)
GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement.)
Hold Occurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
IsEnabledChanged (Inherited from Control.)
JournalEntryRemoved This event is raised during a RemoveBackEntry()()() operation or during a normal back navigation after the Navigated event has been raised.
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 Windows Phone 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 touch capture. (Inherited from UIElement.)
ManipulationCompleted Occurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
ManipulationDelta Occurs when the input device changes position during a manipulation. (Inherited from UIElement.)
ManipulationStarted Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
MouseEnter Occurs when a screen tap occurs within the bounding area of a UIElement. (Inherited from UIElement.)
MouseLeave Occurs when a touch event occurs outside the bounding area of a UIElement. (Inherited from UIElement.)
MouseLeftButtonDown Occurs when a UIElement is tapped. (Inherited from UIElement.)
MouseLeftButtonUp Occurs when the finger is lifted off of a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
MouseMove Occurs when the coordinate position of the finger on the screen while touching a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
MouseWheel Infrastructure. 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. (Inherited from Frame.)
Navigating Occurs when a new navigation is requested. (Inherited from Frame.)
NavigationFailed Occurs when an error is encountered while navigating to the requested content. (Inherited from Frame.)
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. (Inherited from Frame.)
Obscured Occurs when the shell chrome is covering the frame.
OrientationChanged Occurs when the Orientation property has changed.
SizeChanged Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Tap Occurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
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.)
Unobscured Occurs when the shell chrome is no longer covering the frame.

Top

Fields

Name Description
OrientationProperty The dependency property for Orientation.

Top

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

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.

See Also

Reference

Microsoft.Phone.Controls Namespace