Export (0) Print
Expand All

Page Class

Encapsulates content that can be navigated to by a Frame.

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

'Declaration
Public Class Page _
	Inherits UserControl
<sdk:Page .../>
-or-
<sdk:Page ...>
  singleContentElement
</sdk:Page ...>

XAML Values

singleContentElement

Exactly one object element for a class that derives from UIElement. This is almost always an object that can take child elements (such as a Panel) so that multiple elements can be added to content. XAML processing of a UserControl has a special behavior that sets this content to the otherwise protected Content property.

The Page type exposes the following members.

  NameDescription
Public methodPageInitializes a new instance of the Page class.
Top

  NameDescription
Public propertyActualHeightGets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyActualWidthGets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyAllowDropGets 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.)
Public propertyBackgroundGets or sets a brush that provides the background of the control. (Inherited from Control.)
Public propertyBorderBrushGets or sets a brush that describes the border background of a control. (Inherited from Control.)
Public propertyBorderThicknessGets or sets the border thickness of a control. (Inherited from Control.)
Public propertyCacheModeGets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public propertyCharacterSpacingGets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from Control.)
Public propertyClipGets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public propertyContentGets or sets the content that is contained within a user control. (Inherited from UserControl.)
Public propertyCursorGets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyDataContextGets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
Protected propertyDefaultStyleKeyGets or sets the key that references the default style for the control. (Inherited from Control.)
Public propertyDesiredSizeGets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyEffectGets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.)
Public propertyFlowDirectionGets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
Public propertyFontFamilyGets or sets the font used to display text in the control. (Inherited from Control.)
Public propertyFontSizeGets or sets the size of the text in this control. (Inherited from Control.)
Public propertyFontStretchGets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control.)
Public propertyFontStyleGets or sets the style in which the text is rendered. (Inherited from Control.)
Public propertyFontWeightGets or sets the thickness of the specified font. (Inherited from Control.)
Public propertyForegroundGets or sets a brush that describes the foreground color. (Inherited from Control.)
Public propertyHeightGets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyHorizontalAlignmentGets 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.)
Public propertyHorizontalContentAlignmentGets or sets the horizontal alignment of the control's content. (Inherited from Control.)
Public propertyIsEnabledGets or sets a value indicating whether the user can interact with the control. (Inherited from Control.)
Public propertyIsHitTestVisibleGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Public propertyIsTabStopGets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control.)
Public propertyLanguageGets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMarginGets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMaxHeightGets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMaxWidthGets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMinHeightGets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMinWidthGets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyNameGets 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.)
Public propertyNavigationCacheModeGets or sets a value that indicates whether this page is cached and whether it is cached indefinitely.
Public propertyNavigationContextGets an object that contains information about the navigation request.
Public propertyNavigationServiceGets the service that the host used to navigate to this page.
Public propertyOpacityGets or sets the degree of the object's opacity. (Inherited from UIElement.)
Public propertyOpacityMaskGets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Public propertyPaddingGets or sets the padding inside a control. (Inherited from Control.)
Public propertyParentGets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
Public propertyProjectionGets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
Public propertyRenderSizeGets the final render size of a UIElement. (Inherited from UIElement.)
Public propertyRenderTransformGets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
Public propertyRenderTransformOriginGets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.)
Public propertyResourcesGets 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.)
Public propertyStyleGets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Public propertyTabIndexGets 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.)
Public propertyTabNavigationGets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control.)
Public propertyTagGets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Public propertyTemplateGets or sets a control template. (Inherited from Control.)
Public propertyTitleGets or sets the name for the page.
Public propertyTriggersGets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyUseLayoutRoundingGets 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.)
Public propertyVerticalAlignmentGets 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.)
Public propertyVerticalContentAlignmentGets or sets the vertical alignment of the control's content. (Inherited from Control.)
Public propertyVisibilityGets 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.)
Public propertyWidthGets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)
Top

  NameDescription
Public methodAddHandlerAdds 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.)
Public methodApplyTemplateLoads the relevant control template so that its parts can be referenced. (Inherited from Control.)
Public methodArrangePositions 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.)
Protected methodArrangeOverrideProvides the behavior for the Arrange pass of Silverlight layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.)
Public methodCaptureMouseSets mouse capture to a UIElement. (Inherited from UIElement.)
Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindNameRetrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
Public methodFocusAttempts to set the focus on the control. (Inherited from Control.)
Public methodGetAnimationBaseValueReturns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetBindingExpressionRetrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Protected methodGetTemplateChildRetrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodInvalidateArrangeInvalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.)
Public methodInvalidateMeasureInvalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Public methodMeasureUpdates 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.)
Protected methodMeasureOverrideProvides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOnApplyTemplateWhen overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks. (Inherited from FrameworkElement.)
Protected methodOnCreateAutomationPeerWhen implemented in a derived class, returns class-specific AutomationPeer implementations for the Silverlight automation infrastructure. (Inherited from UIElement.)
Protected methodOnDragEnterCalled before the DragEnter event occurs. (Inherited from Control.)
Protected methodOnDragLeaveCalled before the DragLeave event occurs. (Inherited from Control.)
Protected methodOnDragOverCalled before the DragOver event occurs. (Inherited from Control.)
Protected methodOnDropCalled before the Drop event occurs. (Inherited from Control.)
Protected methodOnFragmentNavigationCalled when navigating to a fragment on a page.
Protected methodOnGotFocusCalled before the GotFocus event occurs. (Inherited from Control.)
Protected methodOnKeyDownCalled before the KeyDown event occurs. (Inherited from Control.)
Protected methodOnKeyUpCalled before the KeyUp event occurs. (Inherited from Control.)
Protected methodOnLostFocusCalled before the LostFocus event occurs. (Inherited from Control.)
Protected methodOnLostMouseCaptureCalled before the LostMouseCapture event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.)
Protected methodOnMouseEnterCalled before the MouseEnter event occurs. (Inherited from Control.)
Protected methodOnMouseLeaveCalled before the MouseLeave event occurs. (Inherited from Control.)
Protected methodOnMouseLeftButtonDownCalled before the MouseLeftButtonDown event occurs. (Inherited from Control.)
Protected methodOnMouseLeftButtonUpCalled before the MouseLeftButtonUp event occurs. (Inherited from Control.)
Protected methodOnMouseMoveCalled before the MouseMove event occurs. (Inherited from Control.)
Protected methodOnMouseRightButtonDownCalled before the MouseRightButtonDown event occurs. (Inherited from Control.)
Protected methodOnMouseRightButtonUpCalled before the MouseRightButtonUp event occurs. (Inherited from Control.)
Protected methodOnMouseWheelCalled before the MouseWheel event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.)
Protected methodOnNavigatedFromCalled when a page is no longer the active page in a frame.
Protected methodOnNavigatedToCalled when a page becomes the active page in a frame.
Protected methodOnNavigatingFromCalled just before a page is no longer the active page in a frame.
Protected methodOnTextInputCalled before the TextInput event occurs. (Inherited from Control.)
Protected methodOnTextInputStartCalled before the TextInputStart event occurs. (Inherited from Control.)
Protected methodOnTextInputUpdateCalled before the TextInputUpdate event occurs. (Inherited from Control.)
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodReleaseMouseCaptureRemoves mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.)
Public methodRemoveHandlerRemoves the specified routed event handler from this UIElement. (Inherited from UIElement.)
Public methodSetBindingAttaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTransformToVisualReturns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
Public methodUpdateLayoutEnsures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)
Top

  NameDescription
Public eventBindingValidationErrorOccurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
Public eventDataContextChangedOccurs when the data context for this element changes. (Inherited from FrameworkElement.)
Public eventDragEnterOccurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.)
Public eventDragLeaveOccurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.)
Public eventDragOverOccurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.)
Public eventDropOccurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.)
Public eventGotFocusOccurs when a UIElement receives focus. (Inherited from UIElement.)
Public eventIsEnabledChangedOccurs when the IsEnabled property changes. (Inherited from Control.)
Public eventKeyDownOccurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
Public eventKeyUpOccurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
Public eventLayoutUpdatedOccurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.)
Public eventLoadedOccurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
Public eventLostFocusOccurs when a UIElement loses focus. (Inherited from UIElement.)
Public eventLostMouseCaptureOccurs when the UIElement loses mouse capture. (Inherited from UIElement.)
Public eventMediaCommandOccurs when a button is pressed on a remote control. (Inherited from UIElement.)
Public eventMouseEnterOccurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.)
Public eventMouseLeaveOccurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.)
Public eventMouseLeftButtonDownOccurs 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.)
Public eventMouseLeftButtonUpOccurs 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.)
Public eventMouseMoveOccurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
Public eventMouseRightButtonDownOccurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.)
Public eventMouseRightButtonUpOccurs 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.)
Public eventMouseWheelOccurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
Public eventSizeChangedOccurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Public eventTextInputOccurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
Public eventTextInputStartOccurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
Public eventTextInputUpdateOccurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Public eventUnloadedOccurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)
Top

The Page class enables you to easily create a Silverlight application that supports navigation. You use the Page class to create pieces of content that support navigation from within a Frame. You can create as many different pages as needed to present the content in your application and then navigate to those pages from the frame.

With the Page class, you can support not only navigation to a page of content, but also navigation within that content by providing fragment values. The NavigationContext property provides query string values that you can use to pass values to the page. For example, you may retrieve a query string value to determine which record from a data set to display. When combined with URI mapping, you can create user-friendly URIs that request specific content.

The NavigationService property provides access to the service used by the host to navigate to the page. From within the page, you can navigate to another page or navigate to a new representation of the current page.

You use the NavigationCacheMode property to specify the caching behavior for a page.

You override any of the following methods to add code that responds to navigation events:

NoteNote:

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

The following example shows a Silverlight page that retrieves data from a data service and displays that data. The page displays information about a product based on a value in the query string. The OnNavigatedTo method is overridden to obtain a query string value from the NavigationContext object. The NavigationService object for this page is accessed to determine if forward and back navigation is available.

The first part of the example shows the frame that hosts the page and the URI mappings for the request and query string values.


<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>


The second part shows the XAML page that displays the data.


<!-- NOTE: 
  By convention, the sdk prefix indicates a URI-based XAML namespace declaration 
  for Silverlight SDK client libraries. This namespace declaration is valid for 
  Silverlight 4 only. In Silverlight 3, you must use individual XAML namespace 
  declarations for each CLR assembly and namespace combination outside the scope 
  of the default Silverlight XAML namespace. For more information, see the help 
  topic "Prefixes and Mappings for Silverlight Libraries". 
-->
<sdk:Page x:Class="NavExample.Views.ProductDetail" 
     xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
     xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
     xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
     xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
     mc:Ignorable="d"
     xmlns:sdk="http://schemas.microsoft.com/winfx/2006/xaml/presentation/sdk"
     d:DesignWidth="640" d:DesignHeight="480"
     Title="Product Information">
    <StackPanel x:Name="LayoutRoot">
        <ListBox x:Name="ListBox1" ItemsSource="{Binding}">
            <ListBox.ItemTemplate>
                <DataTemplate>
                    <StackPanel>
                        <TextBlock Text="{Binding Name}"/>
                        <TextBlock Text="{Binding ProductNumber}"/>
                        <TextBlock Text="{Binding Color}"/>
                        <TextBlock Text="{Binding Size}"/>
                        <TextBlock Text="{Binding ListPrice}"/>
                    </StackPanel>
                </DataTemplate>
            </ListBox.ItemTemplate>   
        </ListBox>
        <StackPanel HorizontalAlignment="Center" Orientation="Horizontal">
            <Button Width="100" x:Name="BackNavButton" Click="BackNavButton_Click" 
                    Content="&lt;&lt; back" Visibility="Collapsed" />
            <Button Width="100" x:Name="ForwardNavButton" Click="ForwardNavButton_Click" 
                    Content="forward &gt;&gt;" Visibility="Collapsed" />
        </StackPanel>
    </StackPanel>
</sdk:Page>


The third part shows the code-behind page, which retrieves the data from a data service and determines if navigation buttons are displayed within the page.


Partial Public Class ProductDetail
    Inherits Page

    Public Sub New()
        InitializeComponent()
    End Sub


    Protected Overrides Sub OnNavigatedTo(ByVal e As NavigationEventArgs)
        GetProductDetail()
        SetButtonVisibility()
    End Sub

    Private Sub SetButtonVisibility()
        If (NavigationService.CanGoBack) Then
            BackNavButton.Visibility = Visibility.Visible
        Else
            BackNavButton.Visibility = Visibility.Collapsed
        End If

        If (NavigationService.CanGoForward) Then
            ForwardNavButton.Visibility = Visibility.Visible
        Else
            ForwardNavButton.Visibility = Visibility.Collapsed
        End If
    End Sub

    Private Sub BackNavButton_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
        If (NavigationService.CanGoBack) Then
            NavigationService.GoBack()
        End If
    End Sub

    Private Sub ForwardNavButton_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
        If (NavigationService.CanGoForward) Then
            NavigationService.GoForward()
        End If
    End Sub


    Private Sub GetProductDetail()
        Dim productID As String
        Dim svcContext As DataServiceContext

        svcContext = New DataServiceContext(New Uri("AdventureWorks.svc", _
                UriKind.Relative))

        If (Me.NavigationContext.QueryString.ContainsKey("ProductId")) Then
            productID = Me.NavigationContext.QueryString("ProductId")
        Else
            productID = App.Current.Resources("FeaturedProductID").ToString()
        End If

        svcContext.BeginExecute(Of Product)(New Uri("Product(" + productID + ")", _
                UriKind.Relative), AddressOf loadProductCallback, svcContext)
    End Sub
    Private Sub loadProductCallback(ByVal asyncResult As IAsyncResult)
        Dim context As DataServiceContext
        context = asyncResult.AsyncState
        ListBox1.DataContext = context.EndExecute(Of Product)(asyncResult)
    End Sub

End Class


Silverlight

Supported in: 5, 4, 3

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

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

Community Additions

ADD
Show:
© 2014 Microsoft