Frame.Navigate Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Navigate(TypeName) |
Causes the Frame to load content represented by the specified Page-derived data type. |
| Navigate(TypeName, Object) |
Causes the Frame to load content represented by the specified Page-derived data type, also passing a parameter to be interpreted by the target of the navigation. |
| Navigate(TypeName, Object, NavigationTransitionInfo) |
Causes the Frame to load content represented by the specified Page-derived data type, also passing a parameter to be interpreted by the target of the navigation, and a value indicating the animated transition to use. |
Navigate(TypeName)
public:
virtual bool Navigate(TypeName sourcePageType) = Navigate;bool Navigate(TypeName const& sourcePageType);public bool Navigate(System.Type sourcePageType);function navigate(sourcePageType)Public Function Navigate (sourcePageType As Type) As BooleanParameters
The page to navigate to, specified as a type reference to its partial class type. Must be a Page-derived data type; otherwise, an exception is thrown. (A type reference is given as System.Type for Microsoft .NET, or a TypeName helper struct for Visual C++ component extensions (C++/CX)).
Returns
bool
false if a NavigationFailed event handler has set Handled to true; otherwise, true. See Remarks for more info.
Implements
Remarks
You handle the NavigationFailed event to respond to navigation failure. You can handle the failure directly in the event handler, or you can set the NavigationFailedEventArgs.Handled property to true and use the Navigate method return value to respond to the failure.
Apps typically use GetNavigationState to serialize the frame’s state when the app suspends. You can do this directly in your app code or indirectly by using the SuspensionManager class generated by the Visual Studio templates. To enable frame state serialization using GetNavigationState, you must use only basic types for the navigation parameter, such as string, char, numeric, and GUID types. Otherwise GetNavigationState will throw an exception when the app suspends. The parameter can have other types if you do not use GetNavigationState.
The parameter value can have a complex type if you do not use GetNavigationState. However, you should still use only basic types in order to avoid excess memory usage caused by the frame’s navigation stack holding a reference to the parameter. A preferred approach is to not pass the actual object, but instead pass an identifier that you can use to look up the object in the target landing page. For example, instead of passing a Customer object, pass a reference to the CustomerID, then look up the Customer after the navigation is complete.
Tip
If you are programming using a Microsoft .NET language (C# or Microsoft Visual Basic), the TypeName type projects as System.Type. When programming using C#, it is common to use the typeof operator to get references to the System.Type of a type. In Microsoft Visual Basic, use GetType. If you're using Visual C++ component extensions (C++/CX), where you'll need to create a TypeName helper struct, you can use the typeid component extension.
See also
Applies to
Navigate(TypeName, Object)
public:
virtual bool Navigate(TypeName sourcePageType, Platform::Object ^ parameter) = Navigate;bool Navigate(TypeName const& sourcePageType, IInspectable const& parameter);public bool Navigate(System.Type sourcePageType, object parameter);function navigate(sourcePageType, parameter)Public Function Navigate (sourcePageType As Type, parameter As Object) As BooleanParameters
The page to navigate to, specified as a type reference to its partial class type. Must be a Page-derived data type; otherwise, an exception is thrown. (A type reference is given as System.Type for Microsoft .NET, or a TypeName helper struct for Visual C++ component extensions (C++/CX)).
- parameter
-
Object
Platform::Object
IInspectable
The navigation parameter to pass to the target page; must have a basic type (string, char, numeric, or GUID) to support parameter serialization using GetNavigationState.
Returns
bool
false if a NavigationFailed event handler has set Handled to true; otherwise, true. See Remarks for more info.
See also
Applies to
Navigate(TypeName, Object, NavigationTransitionInfo)
public:
virtual bool Navigate(TypeName sourcePageType, Platform::Object ^ parameter, NavigationTransitionInfo ^ infoOverride) = Navigate;bool Navigate(TypeName const& sourcePageType, IInspectable const& parameter, NavigationTransitionInfo const& infoOverride);public bool Navigate(System.Type sourcePageType, object parameter, NavigationTransitionInfo infoOverride);function navigate(sourcePageType, parameter, infoOverride)Public Function Navigate (sourcePageType As Type, parameter As Object, infoOverride As NavigationTransitionInfo) As BooleanParameters
The page to navigate to, specified as a type reference to its partial class type. Must be a Page-derived data type; otherwise, an exception is thrown. (A type reference is given as System.Type for Microsoft .NET, or a TypeName helper struct for Visual C++ component extensions (C++/CX)).
- parameter
-
Object
Platform::Object
IInspectable
The navigation parameter to pass to the target page; must have a basic type (string, char, numeric, or GUID) to support parameter serialization using GetNavigationState.
- infoOverride
- NavigationTransitionInfo
Info about the animated transition.
Returns
bool
false if a NavigationFailed event handler has set Handled to true; otherwise, true. See Remarks for more info.
Examples
<Frame x:Name="myFrame">
<Frame.ContentTransitions>
<TransitionCollection>
<NavigationThemeTransition />
</TransitionCollection>
</Frame.ContentTransitions>
</Frame>
// Play the default animation
myFrame.Navigate(typeof(Page2), null);
// Explicitly play the page refresh animation
myFrame.Navigate(typeof(Page2), null, new EntranceNavigationTransitionInfo());
// Play the drill in animation
myFrame.Navigate(typeof(Page2), null, new DrillInNavigationTransitionInfo());
// Suppress the default animation
myFrame.Navigate(typeof(Page2), null, new SuppressNavigationTransitionInfo());
See also
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for