NavigationPage Class
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.
A Page that manages the navigation and user-experience of a stack of other pages.
[Xamarin.Forms.RenderWith(typeof(Xamarin.Forms.Platform._NavigationPageRenderer))]
public class NavigationPage : Xamarin.Forms.Page, Xamarin.Forms.IElementConfiguration<Xamarin.Forms.NavigationPage>, Xamarin.Forms.INavigationPageController, Xamarin.Forms.IPageContainer<Xamarin.Forms.Page>type NavigationPage = class
inherit Page
interface IPageContainer<Page>
interface INavigationPageController
interface IElementConfiguration<NavigationPage>- Inheritance
- Attributes
- Implements
Remarks
Note that on the Android platform, INavigation operations do not generate activity lifecycle notifications. For each Page that you push or pop, the Android implementation of NavigationPage simply adds or removes the content of the page to or from a single activity.
Also note that the Windows Phone platform provides navigation natively. Therefore, you do not need to use a NavigationPage object to get navigation on that platform.
Constructors
| NavigationPage() |
Initializes a new NavigationPage object. |
| NavigationPage(Page) |
Creates a new NavigationPage element with |
Fields
| ActionSheetSignalName |
This method is for internal use. (Inherited from Page) |
| AlertSignalName |
This method is for internal use. (Inherited from Page) |
| BackButtonTitleProperty |
Identifies the property associated with the title of the back button. |
| BarBackgroundColorProperty |
Identifies the property associated with the color of the NavigationPage's bar background color. |
| BarBackgroundProperty | |
| BarTextColorProperty |
Identifies the property associated with the color of the NavigationPage's bar text color. |
| BusySetSignalName |
This method is for internal use. (Inherited from Page) |
| CurrentPageProperty |
Identifies the CurrentPage property. |
| HasBackButtonProperty |
Backing store for the HasBackButton property. |
| HasNavigationBarProperty |
Backing store for the HasNavigationBar property. |
| IconColorProperty | |
| PromptSignalName | (Inherited from Page) |
| RootPageProperty |
Identifies the RootPage property. |
| TintProperty |
Obsolete.
Identifies the Tint bindable property. |
| TitleIconImageSourceProperty | |
| TitleIconProperty | |
| TitleViewProperty |
Backing store for the attached property that gets and sets title views. |
Properties
| AnchorX |
Gets or sets the X component of the center point for any transform, relative to the bounds of the element. This is a bindable property. (Inherited from VisualElement) |
| AnchorY |
Gets or sets the Y component of the center point for any transform, relative to the bounds of the element. This is a bindable property. (Inherited from VisualElement) |
| AutomationId |
Gets or sets a value that allows the automation framework to find and interact with this element. (Inherited from Element) |
| Background | (Inherited from VisualElement) |
| BackgroundColor |
Gets or sets the color which will fill the background of a VisualElement. This is a bindable property. (Inherited from VisualElement) |
| BackgroundImage |
Obsolete.
Identifies the image used as a background for the Page. (Inherited from Page) |
| BackgroundImageSource | (Inherited from Page) |
| BarBackground | |
| BarBackgroundColor |
Gets or sets the background color for the bar at the top of the NavigationPage. |
| BarTextColor |
Gets or sets the text that appears on the bar at the top of the NavigationPage. |
| Batched |
For internal use by the Xamarin.Forms platform. (Inherited from VisualElement) |
| Behaviors |
Gets the list of Behaviors associated to this element. This is a bindable property. (Inherited from VisualElement) |
| BindingContext |
Gets or sets object that contains the properties that will be targeted by the bound properties that belong to this BindableObject. (Inherited from BindableObject) |
| Bounds |
Gets the bounds of the element. (Inherited from VisualElement) |
| class | (Inherited from NavigableElement) |
| ClassId |
Gets or sets a value used to identify a collection of semantically similar elements. (Inherited from Element) |
| Clip | (Inherited from VisualElement) |
| ContainerArea |
For internal use by the Xamarin.Forms platform. (Inherited from Page) |
| CurrentPage |
The Page that is currently top-most on the navigation stack. |
| DisableLayout |
For internal use by the Xamarin.Forms platform. (Inherited from VisualElement) |
| Dispatcher | (Inherited from BindableObject) |
| EffectControlProvider |
For internal use by the Xamarin.Forms platform. (Inherited from Element) |
| Effects |
A list of the effects that are applied to this item. (Inherited from Element) |
| FlowDirection |
Gets or sets the layout flow direction. (Inherited from VisualElement) |
| Height |
Gets the current rendered height of this element. This is a read-only bindable property. (Inherited from VisualElement) |
| HeightRequest |
Gets or sets the desired height override of this element. (Inherited from VisualElement) |
| Icon |
Obsolete.
Resource identifier for the Page's associated icon. (Inherited from Page) |
| IconImageSource | (Inherited from Page) |
| Id |
Gets a value that can be used to uniquely identify an element through the run of an application. (Inherited from Element) |
| IgnoresContainerArea |
For internal use by the Xamarin.Forms platform. (Inherited from Page) |
| InputTransparent |
Gets or sets a value indicating whether this element should be involved in the user interaction cycle. This is a bindable property. (Inherited from VisualElement) |
| InternalChildren |
For internal use by the Xamarin.Forms platform. (Inherited from Page) |
| IsBusy |
Marks the Page as busy. This will cause the platform specific global activity indicator to show a busy state. (Inherited from Page) |
| IsEnabled |
Gets or sets a value indicating whether this element is enabled in the user interface. This is a bindable property. (Inherited from VisualElement) |
| IsFocused |
Gets a value indicating whether this element is focused currently. This is a bindable property. (Inherited from VisualElement) |
| IsInNativeLayout |
For internal use by the Xamarin.Forms platform. (Inherited from VisualElement) |
| IsNativeStateConsistent |
For internal use by the Xamarin.Forms platform. (Inherited from VisualElement) |
| IsPlatformEnabled |
For internal use by the Xamarin.Forms platform. (Inherited from VisualElement) |
| IsTabStop |
Gets or sets a value that indicates whether this element is included in tab navigation. This is a bindable property. (Inherited from VisualElement) |
| IsVisible |
Gets or sets a value that determines whether this elements should be part of the visual tree or not. This is a bindable property. (Inherited from VisualElement) |
| LogicalChildren |
For internal use by the Xamarin.Forms platform. (Inherited from Element) |
| MinimumHeightRequest |
Gets or sets a value which overrides the minimum height the element will request during layout. (Inherited from VisualElement) |
| MinimumWidthRequest |
Gets or sets a value which overrides the minimum width the element will request during layout. (Inherited from VisualElement) |
| Navigation | (Inherited from NavigableElement) |
| NavigationProxy | (Inherited from NavigableElement) |
| Opacity |
Gets or sets the opacity value applied to the element when it is rendered. This is a bindable property. (Inherited from VisualElement) |
| Padding |
The space between the content of the Page and it's border. (Inherited from Page) |
| Pages |
For internal use by the Xamarin.Forms platform. |
| Parent |
Gets or sets the parent element of the element. (Inherited from Element) |
| ParentView |
Obsolete.
Gets the element which is the closest ancestor of this element that is a VisualElement. (Inherited from Element) |
| Platform |
Obsolete.
(Inherited from Element)
|
| RealParent |
For internal use by the Xamarin.Forms platform. (Inherited from Element) |
| Resources |
Gets or sets the local resource dictionary. (Inherited from VisualElement) |
| RootPage |
The Page that is the root of the navigation stack. |
| Rotation |
Gets or sets the rotation (in degrees) about the Z-axis (affine rotation) when the element is rendered. (Inherited from VisualElement) |
| RotationX |
Gets or sets the rotation (in degrees) about the X-axis (perspective rotation) when the element is rendered. (Inherited from VisualElement) |
| RotationY |
Gets or sets the rotation (in degrees) about the Y-axis (perspective rotation) when the element is rendered. (Inherited from VisualElement) |
| Scale |
Gets or sets the scale factor applied to the element. (Inherited from VisualElement) |
| ScaleX |
Gets or sets a scale value to apply to the X direction. (Inherited from VisualElement) |
| ScaleY |
Gets or sets a scale value to apply to the Y direction. (Inherited from VisualElement) |
| StackDepth |
For internal use by the Xamarin.Forms platform. |
| Style | (Inherited from NavigableElement) |
| StyleClass | (Inherited from NavigableElement) |
| StyleId |
Gets or sets a user defined value to uniquely identify the element. (Inherited from Element) |
| TabIndex | (Inherited from VisualElement) |
| Tint |
Obsolete.
The color to be used as the Tint of the NavigationPage. |
| Title |
The Page's title. (Inherited from Page) |
| ToolbarItems |
A set of ToolbarItems, implemented in a platform-specific manner. (Inherited from Page) |
| TranslationX |
Gets or sets the X translation delta of the element. (Inherited from VisualElement) |
| TranslationY |
Gets or sets the Y translation delta of the element. (Inherited from VisualElement) |
| Triggers |
Gets the list of Trigger associated to this element. This is a bindable property. (Inherited from VisualElement) |
| Visual | (Inherited from VisualElement) |
| Width |
Gets the current rendered width of this element. This is a read-only bindable property. (Inherited from VisualElement) |
| WidthRequest |
Gets or sets the desired width override of this element. (Inherited from VisualElement) |
| X |
Gets the current X position of this element. This is a read-only bindable property. (Inherited from VisualElement) |
| Y |
Gets the current Y position of this element. This is a read-only bindable property. (Inherited from VisualElement) |
Methods
| ApplyBindings() |
Apply the bindings to BindingContext. (Inherited from BindableObject) |
| BatchBegin() |
Signals the start of a batch of changes to the elements properties. (Inherited from VisualElement) |
| BatchCommit() |
Signals the end of a batch of commands to the element and that those commands should now be committed. (Inherited from VisualElement) |
| ChangeVisualState() |
For internal use by the Xamarin.Forms platform. (Inherited from VisualElement) |
| ClearValue(BindableProperty) |
Clears any value set by SetValue for |
| ClearValue(BindablePropertyKey) |
Clears any value set by SetValue for the property that is identified by |
| CoerceValue(BindableProperty) | (Inherited from BindableObject) |
| CoerceValue(BindablePropertyKey) | (Inherited from BindableObject) |
| Descendants() |
For internal use by the Xamarin.Forms platform. (Inherited from Element) |
| DisplayActionSheet(String, String, String, String[]) |
Displays a native platform action sheet, allowing the application user to choose from several buttons. (Inherited from Page) |
| DisplayAlert(String, String, String, String) |
Presents an alert dialog to the application user with an accept and a cancel button. (Inherited from Page) |
| DisplayAlert(String, String, String) |
Presents an alert dialog to the application user with a single cancel button. (Inherited from Page) |
| DisplayPromptAsync(String, String, String, String, String, Int32, Keyboard, String) | (Inherited from Page) |
| DisplayPromptAsync(String, String, String, String, String, Int32, Keyboard) |
Obsolete.
(Inherited from Page)
|
| EffectIsAttached(String) |
For internal use by the Xamarin.Forms platform. (Inherited from Element) |
| FindByName(String) |
Returns the element that has the specified name. (Inherited from Element) |
| Focus() |
Attemps to set focus to this element. (Inherited from VisualElement) |
| ForceLayout() |
Forces the Page to perform a layout pass. (Inherited from Page) |
| GetBackButtonTitle(BindableObject) |
The title of the back button for the specified |
| GetHasBackButton(Page) |
Returns a value that indicates whether |
| GetHasNavigationBar(BindableObject) |
Returns a value that indicates whether the |
| GetIconColor(BindableObject) | |
| GetSizeRequest(Double, Double) |
Obsolete.
Returns the SizeRequest of the element. Calling this method begins the measure pass of a layout cycle. (Inherited from VisualElement) |
| GetTitleIcon(BindableObject) | |
| GetTitleIconImageSource(BindableObject) | |
| GetTitleView(BindableObject) |
Returns the view to use as a title for the navigation page. |
| GetValue(BindableProperty) |
Returns the value that is contained in the BindableProperty. (Inherited from BindableObject) |
| GetValues(BindableProperty, BindableProperty, BindableProperty) |
Obsolete.
For internal use by the Xamarin.Forms platform. (Inherited from BindableObject) |
| GetValues(BindableProperty, BindableProperty) |
Obsolete.
For internal use by the Xamarin.Forms platform. (Inherited from BindableObject) |
| InvalidateMeasure() |
Method that is called to invalidate the layout of this VisualElement. Raises the MeasureInvalidated event. (Inherited from VisualElement) |
| InvalidateMeasureNonVirtual(InvalidationTrigger) |
For internal use by the Xamarin.Forms platform. (Inherited from VisualElement) |
| IsSet(BindableProperty) |
Returns |
| Layout(Rectangle) |
Updates the bounds of the element during the layout cycle. (Inherited from VisualElement) |
| LayoutChildren(Double, Double, Double, Double) |
Lays out children Elements into the specified area. (Inherited from Page) |
| Measure(Double, Double, MeasureFlags) |
Returns the minimum size that a visual element needs in order to be displayed on the device. (Inherited from VisualElement) |
| NativeSizeChanged() |
For internal use by the Xamarin.Forms platform. (Inherited from VisualElement) |
| On<T>() |
Returns the platform-specific instance of this NavigationPage, on which a platform-specific method may be called. |
| OnAppearing() |
When overridden, allows application developers to customize behavior immediately prior to the Page becoming visible. (Inherited from Page) |
| OnBackButtonPressed() |
Event that is raised when the hardware back button is pressed. This event is not raised on iOS. |
| OnBindingContextChanged() |
Invoked whenever the binding context of the Page changes. Override this method to add class handling for this event. (Inherited from Page) |
| OnChildAdded(Element) |
Application developers can override this method to respond when a child is added. (Inherited from VisualElement) |
| OnChildMeasureInvalidated(Object, EventArgs) |
Indicates that the preferred size of a child Element has changed. (Inherited from Page) |
| OnChildRemoved(Element, Int32) | (Inherited from VisualElement) |
| OnChildRemoved(Element) |
Obsolete.
Application developers can override this method to respond when a child is removed. (Inherited from VisualElement) |
| OnChildrenReordered() |
Invoked whenever the ChildrenReordered event is about to be emitted. Implement this method to add class handling for this event. (Inherited from VisualElement) |
| OnDisappearing() |
When overridden, allows the application developer to customize behavior as the Page disappears. (Inherited from Page) |
| OnMeasure(Double, Double) |
Method that is called when a layout measurement happens. (Inherited from VisualElement) |
| OnParentSet() |
Called when the Page's Parent property has changed. (Inherited from Page) |
| OnPropertyChanged(String) |
Method that is called when a bound property is changed. (Inherited from Element) |
| OnPropertyChanging(String) |
Call this method from a child class to notify that a change is going to happen on a property. (Inherited from BindableObject) |
| OnSizeAllocated(Double, Double) |
Indicates that the Page has been assigned a size. (Inherited from Page) |
| OnSizeRequest(Double, Double) |
Obsolete.
This method is called during the measure pass of a layout cycle to get the desired size of an element. (Inherited from VisualElement) |
| OnTabIndexPropertyChanged(Int32, Int32) | (Inherited from VisualElement) |
| OnTabStopPropertyChanged(Boolean, Boolean) | (Inherited from VisualElement) |
| Peek(Int32) |
For internal use by the Xamarin.Forms platform. |
| PopAsync() |
Asynchronously removes the top Page from the navigation stack. |
| PopAsync(Boolean) |
Asynchronously removes the top Page from the navigation stack, with optional animation. |
| PopAsyncInner(Boolean, Boolean) |
For internal use by the Xamarin.Forms platform. |
| PopToRootAsync() |
Pops all but the root Page off the navigation stack. |
| PopToRootAsync(Boolean) |
A task for asynchronously popping all pages off of the navigation stack. |
| PushAsync(Page, Boolean) |
A task for asynchronously pushing a page onto the navigation stack, with optional animation. |
| PushAsync(Page) |
Presents a Page by asynchronously pushing it onto the navigation stack. |
| RemoveBinding(BindableProperty) |
Removes a previously set binding. (Inherited from BindableObject) |
| RemoveDynamicResource(BindableProperty) |
Removes a previously set dynamic resource (Inherited from Element) |
| SendAppearing() |
For internal use by the Xamarin.Forms platform. (Inherited from Page) |
| SendBackButtonPressed() |
Calls OnBackButtonPressed(). (Inherited from Page) |
| SendDisappearing() |
For internal use by the Xamarin.Forms platform. (Inherited from Page) |
| SetBackButtonTitle(BindableObject, String) |
Sets the title that appears on the back button for |
| SetBinding(BindableProperty, BindingBase) |
Assigns a binding to a property. (Inherited from BindableObject) |
| SetDynamicResource(BindableProperty, String) |
Sets the BindableProperty property of this element to be updated via the DynamicResource with the provided key. (Inherited from Element) |
| SetHasBackButton(Page, Boolean) |
Adds or removes a back button to |
| SetHasNavigationBar(BindableObject, Boolean) |
Sets a value that indicates whether or not this NavigationPage element has a navigation bar. |
| SetIconColor(BindableObject, Color) | |
| SetTitleIcon(BindableObject, FileImageSource) | |
| SetTitleIconImageSource(BindableObject, ImageSource) | |
| SetTitleView(BindableObject, View) |
Sets the view to use as the title for the navigation page. |
| SetValue(BindableProperty, Object) |
Sets the value of the specified property. (Inherited from BindableObject) |
| SetValue(BindablePropertyKey, Object) |
Sets the value of the propertyKey. (Inherited from BindableObject) |
| SetValueCore(BindableProperty, Object, SetValueFlags) |
For internal use by the Xamarin.Forms platform. (Inherited from BindableObject) |
| SetValueFromRenderer(BindableProperty, Object) |
For internal use by the Xamarin.Forms platform. (Inherited from Element) |
| SetValueFromRenderer(BindablePropertyKey, Object) |
For internal use by the Xamarin.Forms platform. (Inherited from Element) |
| SizeAllocated(Double, Double) |
SizeAllocated is called during a layout cycle to signal the start of a sub-tree layout. (Inherited from VisualElement) |
| TabIndexDefaultValueCreator() | (Inherited from VisualElement) |
| TabStopDefaultValueCreator() | (Inherited from VisualElement) |
| UnapplyBindings() |
Unapplies all previously set bindings. (Inherited from BindableObject) |
| Unfocus() |
Unsets focus to this element. (Inherited from VisualElement) |
| UpdateChildrenLayout() |
Requests that the children Elements of the Page update their layouts. (Inherited from Page) |
Events
| Appearing |
Indicates that the Page is about to appear. (Inherited from Page) |
| BatchCommitted |
For internal use by the Xamarin.Forms platform. (Inherited from VisualElement) |
| BindingContextChanged |
Raised whenever the BindingContext property changes. (Inherited from BindableObject) |
| ChildAdded |
Occurs whenever a child element is added to the element. (Inherited from Element) |
| ChildRemoved |
Occurs whenever a child element is removed from the element. (Inherited from Element) |
| ChildrenReordered |
Occurs when the Children of a VisualElement have been re-ordered. (Inherited from VisualElement) |
| DescendantAdded |
Occurs whenever a child element is added to the elements subtree. (Inherited from Element) |
| DescendantRemoved |
Occurs whenever a child element is removed from the elements subtree. (Inherited from Element) |
| Disappearing |
Indicates that the Page is about to cease displaying. (Inherited from Page) |
| FocusChangeRequested |
For internal use by the Xamarin.Forms platform. (Inherited from VisualElement) |
| Focused |
Occurs when the element receives focus. (Inherited from VisualElement) |
| InsertPageBeforeRequested |
For internal use by the Xamarin.Forms platform. |
| LayoutChanged |
Raised when the layout of the Page has changed. (Inherited from Page) |
| MeasureInvalidated |
Event that is raised when the layout of a visual element is invalidated. (Inherited from VisualElement) |
| PlatformSet |
Obsolete.
(Inherited from Element)
|
| Popped |
Event that is raised after a page is popped from this NavigationPage element. |
| PoppedToRoot |
Event that is raised when the last nonroot element is popped from this NavigationPage element. |
| PopRequested |
For internal use by the Xamarin.Forms platform. |
| PopToRootRequested |
For internal use by the Xamarin.Forms platform. |
| PropertyChanged |
Raised when a property has changed. (Inherited from BindableObject) |
| PropertyChanging |
Raised when a property is about to change. (Inherited from BindableObject) |
| Pushed |
Event that is raised when a page is pushed onto this NavigationPage element. |
| PushRequested |
For internal use by the Xamarin.Forms platform. |
| RemovePageRequested |
For internal use by the Xamarin.Forms platform. |
| SizeChanged |
Occurs when either the Width or the Height properties change value on this element. (Inherited from VisualElement) |
| Unfocused |
Occurs when the element loses focus. (Inherited from VisualElement) |
Explicit Interface Implementations
| IDynamicResourceHandler.SetDynamicResource(BindableProperty, String) |
For internal use by the Xamarin.Forms platform. (Inherited from BindableObject) |
| IElementController.SetValueFromRenderer(BindableProperty, Object) |
For internal use by the Xamarin.Forms platform. (Inherited from Element) |
| INameScope.RegisterName(String, Object) |
For internal use only. (Inherited from Element) |
| INavigationPageController.RemoveAsyncInner(Page, Boolean, Boolean) |
For internal use by the Xamarin.Forms platform. |
| IVisualElementController.EffectiveFlowDirection |
Gets the effective visual flow direction for the element on the platform, taking into account the locale and logical flow settings. (Inherited from VisualElement) |
| IVisualElementController.InvalidateMeasure(InvalidationTrigger) |
This method is for internal use. (Inherited from VisualElement) |