NavigationPage Class
Definition
A navigation page that supports simple stack-based navigation.
public class NavigationPage
Constructors
| Name | Description |
|---|---|
| NavigationPage | Initializes a new instance of Avalonia.Controls.NavigationPage. |
NavigationPage Constructor
Initializes a new instance of Avalonia.Controls.NavigationPage.
public NavigationPage()
Methods
| Name | Description |
|---|---|
| AddHandler (2 overloads) | Adds a handler for the specified routed event. Inherited from Interactive. |
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| ApplyTemplate | Creates the visual children of the control, if necessary Inherited from TemplatedControl. |
| Arrange | Arranges the control and its children. Inherited from Layoutable. |
| BeginInit | Inherited from StyledElement. |
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| CheckAccess | Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject. |
| ClearValue (4 overloads) | Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject. |
| CoerceValue | Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject. |
| EndInit | Inherited from StyledElement. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| Focus | Focuses the control. Inherited from InputElement. |
| GetBackButtonContent | Gets the custom back-button content for the specified page. |
| GetBarHeightOverride | Gets the per-page navigation bar height override for the specified page. |
| GetBarLayoutBehavior | Gets the bar layout behavior for the specified page. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetBottomCommandBar | Gets the bottom command bar assigned to the specified page. |
| GetFlowDirection | Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| GetHasBackButton | Gets whether the back button is visible for the specified page. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetHasNavigationBar | Gets whether the navigation bar is visible for the specified page. |
| GetHeader | Gets the header of the specified page. |
| GetIsBackButtonEnabled | Gets whether the back button is enabled for the specified page. |
| GetIsHoldingEnabled | Inherited from InputElement. |
| GetIsHoldWithMouseEnabled | Inherited from InputElement. |
| GetIsTemplateFocusTarget | Gets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl. |
| GetTopCommandBar | Gets the top command bar assigned to the specified page. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| InsertPage | Inserts a page into the stack before the specified page. |
| InvalidateArrange | Invalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateMeasure | Invalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateVisual | Invalidates the visual and queues a repaint. Inherited from Visual. |
| IsAnimating | Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject. |
| IsSet | Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject. |
| Measure | Carries out a measure of the control. Inherited from Layoutable. |
| PopAllModalsAsync (2 overloads) | Pops all modal pages using Avalonia.Controls.NavigationPage.ModalTransition. |
| PopAsync (2 overloads) | Pops the top page from the navigation stack asynchronously using Avalonia.Controls.NavigationPage.PageTransition. |
| PopModalAsync (2 overloads) | Pops the top modal page using Avalonia.Controls.NavigationPage.ModalTransition. |
| PopToPageAsync (2 overloads) | Pops to a specific page in the stack using Avalonia.Controls.NavigationPage.PageTransition. |
| PopToRootAsync (2 overloads) | Pops all pages to the root page using Avalonia.Controls.NavigationPage.PageTransition. |
| PushAsync (2 overloads) | Pushes page onto the navigation stack asynchronously using Avalonia.Controls.NavigationPage.PageTransition. |
| PushModalAsync (2 overloads) | Pushes a modal page using Avalonia.Controls.NavigationPage.ModalTransition. |
| RaiseEvent | Raises a routed event. Inherited from Interactive. |
| RemoveHandler (2 overloads) | Removes a handler for the specified routed event. Inherited from Interactive. |
| RemovePage | Removes a page from the navigation stack without animation. |
| Render | Renders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual. |
| ReplaceAsync (2 overloads) | Replaces the top page with page using Avalonia.Controls.NavigationPage.PageTransition. |
| SetBackButtonContent | Sets custom content for the back button on the specified page. |
| SetBarHeightOverride | No summary available. |
| SetBarLayoutBehavior | No summary available. |
| SetBottomCommandBar | Sets a bottom command bar for the specified page. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetFlowDirection | Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| SetHasBackButton | Sets whether the back button is visible for the specified page. |
| SetHasNavigationBar | Sets whether the navigation bar is visible for the specified page. |
| SetHeader | Sets the header of the specified page. |
| SetIsBackButtonEnabled | Sets whether the back button is enabled for the specified page. |
| SetIsHoldingEnabled | Inherited from InputElement. |
| SetIsHoldWithMouseEnabled | Inherited from InputElement. |
| SetIsTemplateFocusTarget | Sets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl. |
| SetTopCommandBar | Sets a top command bar for the specified page. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| TryGetResource | Inherited from StyledElement. |
| UpdateLayout | Executes a layout pass. Inherited from Layoutable. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
GetBackButtonContent Method
Gets the custom back-button content for the specified page.
public object GetBackButtonContent(Avalonia.Controls.Page page)
Parameters
Returns
object
GetBarHeightOverride Method
Gets the per-page navigation bar height override for the specified page.
public Nullable<double> GetBarHeightOverride(Avalonia.Controls.Page page)
Parameters
Returns
Nullable<double>
GetBarLayoutBehavior Method
Gets the bar layout behavior for the specified page.
public Nullable<Avalonia.Controls.BarLayoutBehavior> GetBarLayoutBehavior(Avalonia.Controls.Page page)
Parameters
Returns
Nullable<Avalonia.Controls.BarLayoutBehavior>
GetBottomCommandBar Method
Gets the bottom command bar assigned to the specified page.
public Avalonia.Controls.Control GetBottomCommandBar(Avalonia.Controls.Page page)
Parameters
Returns
GetHasBackButton Method
Gets whether the back button is visible for the specified page.
public bool GetHasBackButton(Avalonia.Controls.Page page)
Parameters
Returns
bool
GetHasNavigationBar Method
Gets whether the navigation bar is visible for the specified page.
public bool GetHasNavigationBar(Avalonia.Controls.Page page)
Parameters
Returns
bool
GetHeader Method
Gets the header of the specified page.
public object GetHeader(Avalonia.Controls.Page page)
Parameters
Returns
object
GetIsBackButtonEnabled Method
Gets whether the back button is enabled for the specified page.
public bool GetIsBackButtonEnabled(Avalonia.Controls.Page page)
Parameters
Returns
bool
GetTopCommandBar Method
Gets the top command bar assigned to the specified page.
public Avalonia.Controls.Control GetTopCommandBar(Avalonia.Controls.Page page)
Parameters
Returns
InsertPage Method
Inserts a page into the stack before the specified page.
public void InsertPage(Avalonia.Controls.Page page, Avalonia.Controls.Page before)
Parameters
before Avalonia.Controls.Page
Remarks
If a navigation transition is already in progress (Avalonia.Controls.NavigationPage.IsNavigating is ), this call is a no-op: the page is not inserted and no events are raised.
PopAllModalsAsync overloads
PopAllModalsAsync Method
Pops all modal pages using Avalonia.Controls.NavigationPage.ModalTransition.
public System.Threading.Tasks.Task PopAllModalsAsync()
Returns
System.Threading.Tasks.Task
Remarks
All modals are dismissed in a single transition rather than one-by-one, so lifecycle events differ from calling Avalonia.Controls.NavigationPage.PopModalAsync in a loop:
- Avalonia.Controls.Page.Navigating is consulted only on the topmost modal. Intermediate modals do not receive a cancellation opportunity. If the top modal cancels, the entire dismiss is aborted and no modals are popped.
- Avalonia.Controls.Page.NavigatedFrom fires on every dismissed modal in LIFO order.
- Avalonia.Controls.Page.NavigatedTo fires only on Avalonia.Controls.Page.CurrentPage.
PopAllModalsAsync Method
Pops all modal pages using transition.
public System.Threading.Tasks.Task PopAllModalsAsync(Avalonia.Animation.IPageTransition transition)
Parameters
transition Avalonia.Animation.IPageTransition
Returns
System.Threading.Tasks.Task
Remarks
All modals are dismissed in a single transition rather than one-by-one, so lifecycle events differ from calling Avalonia.Controls.NavigationPage.PopModalAsync in a loop:
- Avalonia.Controls.Page.Navigating is consulted only on the topmost modal. Intermediate modals do not receive a cancellation opportunity. If the top modal cancels, the entire dismiss is aborted and no modals are popped.
- Avalonia.Controls.Page.NavigatedFrom fires on every dismissed modal in LIFO order.
- Avalonia.Controls.Page.NavigatedTo fires only on Avalonia.Controls.Page.CurrentPage.
PopAsync overloads
PopAsync Method
Pops the top page from the navigation stack asynchronously using Avalonia.Controls.NavigationPage.PageTransition.
public System.Threading.Tasks.Task<Avalonia.Controls.Page> PopAsync()
Returns
System.Threading.Tasks.Task<Avalonia.Controls.Page>
Remarks
Returns if the stack has only the root page or if a navigation transition is already in progress (Avalonia.Controls.NavigationPage.IsNavigating is ).
PopAsync Method
Pops the top page from the navigation stack asynchronously using transition.
public System.Threading.Tasks.Task<Avalonia.Controls.Page> PopAsync(Avalonia.Animation.IPageTransition transition)
Parameters
transition Avalonia.Animation.IPageTransition
Returns
System.Threading.Tasks.Task<Avalonia.Controls.Page>
PopModalAsync overloads
PopModalAsync Method
Pops the top modal page using Avalonia.Controls.NavigationPage.ModalTransition.
public System.Threading.Tasks.Task<Avalonia.Controls.Page> PopModalAsync()
Returns
System.Threading.Tasks.Task<Avalonia.Controls.Page>
Remarks
Returns if there are no modal pages or if a navigation transition is already in progress (Avalonia.Controls.NavigationPage.IsNavigating is ).
PopModalAsync Method
Pops the top modal page using transition.
public System.Threading.Tasks.Task<Avalonia.Controls.Page> PopModalAsync(Avalonia.Animation.IPageTransition transition)
Parameters
transition Avalonia.Animation.IPageTransition
Returns
System.Threading.Tasks.Task<Avalonia.Controls.Page>
PopToPageAsync overloads
PopToPageAsync Method
Pops to a specific page in the stack using Avalonia.Controls.NavigationPage.PageTransition.
public System.Threading.Tasks.Task PopToPageAsync(Avalonia.Controls.Page page)
Parameters
Returns
System.Threading.Tasks.Task
Remarks
All pages above page are removed from the stack. Each removed page
receives a Avalonia.Controls.Page.NavigatedFrom call with Avalonia.Controls.NavigationType.Pop,
and Avalonia.Controls.NavigationPage.Popped is raised for each one. The target page receives
Avalonia.Controls.Page.NavigatedTo with Avalonia.Controls.NavigationType.Pop. If
page is already the top of the stack the method returns immediately
without raising any events.
If a navigation transition is already in progress (Avalonia.Controls.NavigationPage.IsNavigating is ), the call returns immediately without modifying the stack and without raising any events.
PopToPageAsync Method
Pops all pages above page using transition.
public System.Threading.Tasks.Task PopToPageAsync(Avalonia.Controls.Page page, Avalonia.Animation.IPageTransition transition)
Parameters
transition Avalonia.Animation.IPageTransition
Returns
System.Threading.Tasks.Task
PopToRootAsync overloads
PopToRootAsync Method
Pops all pages to the root page using Avalonia.Controls.NavigationPage.PageTransition.
public System.Threading.Tasks.Task PopToRootAsync()
Returns
System.Threading.Tasks.Task
Remarks
If a navigation transition is already in progress (Avalonia.Controls.NavigationPage.IsNavigating is ), the call returns immediately without modifying the stack and without raising any events.
PopToRootAsync Method
Pops all pages to the root page using transition.
public System.Threading.Tasks.Task PopToRootAsync(Avalonia.Animation.IPageTransition transition)
Parameters
transition Avalonia.Animation.IPageTransition
Returns
System.Threading.Tasks.Task
PushAsync overloads
PushAsync Method
Pushes page onto the navigation stack asynchronously using Avalonia.Controls.NavigationPage.PageTransition.
public System.Threading.Tasks.Task PushAsync(Avalonia.Controls.Page page)
Parameters
Returns
System.Threading.Tasks.Task
Remarks
If a navigation transition is already in progress (Avalonia.Controls.NavigationPage.IsNavigating is ), the call returns immediately without pushing the page and without raising any events. If the outgoing page's Avalonia.Controls.Page.Navigating handler sets Avalonia.Controls.NavigatingFromEventArgs.Cancel to , the push is silently aborted: the stack is not modified, no events are raised, and no exception is thrown.
PushAsync Method
Pushes page onto the navigation stack asynchronously using transition.
public System.Threading.Tasks.Task PushAsync(Avalonia.Controls.Page page, Avalonia.Animation.IPageTransition transition)
Parameters
transition Avalonia.Animation.IPageTransition
Returns
System.Threading.Tasks.Task
PushModalAsync overloads
PushModalAsync Method
Pushes a modal page using Avalonia.Controls.NavigationPage.ModalTransition.
public System.Threading.Tasks.Task PushModalAsync(Avalonia.Controls.Page page)
Parameters
Returns
System.Threading.Tasks.Task
Remarks
If a navigation transition is already in progress (Avalonia.Controls.NavigationPage.IsNavigating is ), the call returns immediately without pushing the page and without raising any events.
PushModalAsync Method
Pushes page as a modal page using transition.
public System.Threading.Tasks.Task PushModalAsync(Avalonia.Controls.Page page, Avalonia.Animation.IPageTransition transition)
Parameters
transition Avalonia.Animation.IPageTransition
Returns
System.Threading.Tasks.Task
RemovePage Method
Removes a page from the navigation stack without animation.
public void RemovePage(Avalonia.Controls.Page page)
Parameters
Remarks
If a navigation transition is already in progress (Avalonia.Controls.NavigationPage.IsNavigating is ), this call is a no-op: the page is not removed and no events are raised.
ReplaceAsync overloads
ReplaceAsync Method
Replaces the top page with page using Avalonia.Controls.NavigationPage.PageTransition.
public System.Threading.Tasks.Task ReplaceAsync(Avalonia.Controls.Page page)
Parameters
Returns
System.Threading.Tasks.Task
Remarks
If a navigation transition is already in progress (Avalonia.Controls.NavigationPage.IsNavigating is ), the call returns immediately without modifying the stack and without raising any events.
ReplaceAsync Method
Replaces the top page with page using transition.
public System.Threading.Tasks.Task ReplaceAsync(Avalonia.Controls.Page page, Avalonia.Animation.IPageTransition transition)
Parameters
transition Avalonia.Animation.IPageTransition
Returns
System.Threading.Tasks.Task
SetBackButtonContent Method
Sets custom content for the back button on the specified page.
public void SetBackButtonContent(Avalonia.Controls.Page page, object content)
Parameters
content object
SetBarHeightOverride Method
public void SetBarHeightOverride(Avalonia.Controls.Page page, Nullable<double> value)
Parameters
value Nullable<double>
SetBarLayoutBehavior Method
public void SetBarLayoutBehavior(Avalonia.Controls.Page page, Nullable<Avalonia.Controls.BarLayoutBehavior> value)
Parameters
value Nullable<Avalonia.Controls.BarLayoutBehavior>
SetBottomCommandBar Method
Sets a bottom command bar for the specified page.
public void SetBottomCommandBar(Avalonia.Controls.Page page, Avalonia.Controls.Control commandBar)
Parameters
commandBar Avalonia.Controls.Control
SetHasBackButton Method
Sets whether the back button is visible for the specified page.
public void SetHasBackButton(Avalonia.Controls.Page page, bool value)
Parameters
value bool
SetHasNavigationBar Method
Sets whether the navigation bar is visible for the specified page.
public void SetHasNavigationBar(Avalonia.Controls.Page page, bool value)
Parameters
value bool
SetHeader Method
Sets the header of the specified page.
public void SetHeader(Avalonia.Controls.Page page, object header)
Parameters
header object
SetIsBackButtonEnabled Method
Sets whether the back button is enabled for the specified page.
public void SetIsBackButtonEnabled(Avalonia.Controls.Page page, bool value)
Parameters
value bool
SetTopCommandBar Method
Sets a top command bar for the specified page.
public void SetTopCommandBar(Avalonia.Controls.Page page, Avalonia.Controls.Control commandBar)
Parameters
commandBar Avalonia.Controls.Control
Properties
| Name | Description |
|---|---|
| ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement. |
| Background | Gets or sets the brush used to draw the control's background. Inherited from TemplatedControl. |
| BackgroundSizing | Gets or sets how the control's background is drawn relative to the control's border. Inherited from TemplatedControl. |
| BarHeight | Gets or sets the height of the navigation bar. |
| BorderBrush | Gets or sets the brush used to draw the control's border. Inherited from TemplatedControl. |
| BorderThickness | Gets or sets the thickness of the control's border. Inherited from TemplatedControl. |
| Bounds | Gets the bounds of the control relative to its parent. Inherited from Visual. |
| CacheMode | Gets or sets the cache mode of the visual. Inherited from Visual. |
| CanGoBack | Gets whether the navigation stack has more than one entry. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| Clip | Gets or sets the geometry clip for this visual. Inherited from Visual. |
| ClipToBounds | Gets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual. |
| Content | Gets or sets the root page of the navigation stack. |
| ContextFlyout | Gets or sets a context flyout to the control Inherited from Control. |
| ContextMenu | Gets or sets a context menu to the control. Inherited from Control. |
| CornerRadius | Gets or sets the radius of the border rounded corners. Inherited from TemplatedControl. |
| CurrentPage | Gets or sets the currently active child page. Inherited from Page. |
| Cursor | Gets or sets associated mouse cursor. Inherited from InputElement. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| DataTemplates | Gets or sets the data templates for the control. Inherited from Control. |
| DesiredSize | Gets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Effect | Gets or sets the effect of the control. Inherited from Visual. |
| EffectiveBarHeight | Gets the effective navigation bar height. |
| FlowDirection | Gets or sets the text flow direction. Inherited from Visual. |
| Focusable | Gets or sets a value indicating whether the control can receive focus. Inherited from InputElement. |
| FocusAdorner | Gets or sets the control's focus adorner. Inherited from Control. |
| FontFamily | Gets or sets the font family used to draw the control's text. Inherited from TemplatedControl. |
| FontFeatures | Gets or sets the font features turned on/off. Inherited from TemplatedControl. |
| FontSize | Gets or sets the size of the control's text in points. Inherited from TemplatedControl. |
| FontStretch | Gets or sets the font stretch used to draw the control's text. Inherited from TemplatedControl. |
| FontStyle | Gets or sets the font style used to draw the control's text. Inherited from TemplatedControl. |
| FontWeight | Gets or sets the font weight used to draw the control's text. Inherited from TemplatedControl. |
| Foreground | Gets or sets the brush used to draw the control's text and other foreground elements. Inherited from TemplatedControl. |
| GestureRecognizers | Inherited from InputElement. |
| HasMirrorTransform | Gets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual. |
| HasShadow | Gets or sets whether the navigation bar has a shadow. |
| Header | Gets or sets the header content displayed in the navigation bar or tab strip. Inherited from Page. |
| HeaderTemplate | Gets or sets the data template used to display the header. Inherited from Page. |
| Height | Gets or sets the height of the element. Inherited from Layoutable. |
| HorizontalAlignment | Gets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable. |
| Icon | Gets or sets the icon displayed alongside the page header. Inherited from Page. |
| IconTemplate | Gets or sets the data template used to display the icon. Inherited from Page. |
| IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable. |
| IsBackButtonEffectivelyVisible | Gets the effective back-button visibility. |
| IsBackButtonVisible | Gets or sets whether the back button is globally visible for this NavigationPage. |
| IsEffectivelyEnabled | Gets a value indicating whether this control and all its parents are enabled. Inherited from InputElement. |
| IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. Inherited from Visual. |
| IsEnabled | Gets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement. |
| IsFocused | Gets a value indicating whether the control is focused. Inherited from InputElement. |
| IsGestureEnabled | Gets or sets whether edge-swipe gestures can be used to navigate back. |
| IsHitTestVisible | Gets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| IsInNavigationPage | Gets or sets whether this page is currently hosted inside a NavigationPage. Inherited from Page. |
| IsKeyboardFocusWithin | Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement. |
| IsLoaded | Gets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. Inherited from Control. |
| IsMeasureValid | Gets a value indicating whether the control's layout measure is valid. Inherited from Layoutable. |
| IsNavigating | Gets whether a navigation operation is currently in progress. |
| IsPointerOver | Gets a value indicating whether the pointer is currently over the control. Inherited from InputElement. |
| IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement. |
| IsVisible | Gets or sets a value indicating whether this control is visible. Inherited from Visual. |
| Item | Inherited from AvaloniaObject. |
| ItemsSource | Gets or sets a view-model collection to bind to. Use together with Avalonia.Controls.MultiPage.PageTemplate to convert each item into a Avalonia.Controls.Page. When set, takes precedence over Avalonia.Controls.MultiPage.Pages as the item source for the inner tab or carousel control. Inherited from MultiPage. |
| KeyBindings | Inherited from InputElement. |
| LetterSpacing | Gets or sets the letter spacing for the control's text content. Inherited from TemplatedControl. |
| Margin | Gets or sets the margin around the element. Inherited from Layoutable. |
| MaxHeight | Gets or sets the maximum height of the element. Inherited from Layoutable. |
| MaxWidth | Gets or sets the maximum width of the element. Inherited from Layoutable. |
| MinHeight | Gets or sets the minimum height of the element. Inherited from Layoutable. |
| MinWidth | Gets or sets the minimum width of the element. Inherited from Layoutable. |
| ModalStack | Gets the current modal stack. Index 0 is the oldest (bottom-most) modal; the last index is the most recently pushed (topmost) modal. |
| ModalTransition | Gets or sets the transition used when presenting or dismissing modal pages. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| Navigation | Gets or sets the Avalonia.Controls.INavigation service provided by the parent NavigationPage. Inherited from Page. |
| NavigationStack | Gets the current navigation stack as a read-only list. |
| Opacity | Gets or sets the opacity of the control. Inherited from Visual. |
| OpacityMask | Gets or sets the opacity mask of the control. Inherited from Visual. |
| Padding | Gets or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl. |
| Pages | Gets or sets the collection of child pages. Inherited from MultiPage. |
| PageTemplate | Gets or sets the data template used to create pages from view-model items. Inherited from MultiPage. |
| PageTransition | Gets or sets the transition used when pushing or popping pages. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| RenderTransform | Gets or sets the render transform of the control. Inherited from Visual. |
| RenderTransformOrigin | Gets or sets the transform origin of the control. Inherited from Visual. |
| Resources | Gets or sets the styled element's resource dictionary. Inherited from StyledElement. |
| SafeAreaPadding | Gets or sets the safe-area padding applied to this page's content. Inherited from Page. |
| StackDepth | Gets the number of pages in the navigation stack. |
| StyleKey | Gets the type by which the element is styled. Inherited from StyledElement. |
| Styles | Gets the styles for the styled element. Inherited from StyledElement. |
| TabIndex | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. Inherited from InputElement. |
| Tag | Gets or sets a user-defined object attached to the control. Inherited from Control. |
| Template | Gets or sets the template that defines the control's appearance. Inherited from TemplatedControl. |
| TemplatedParent | Gets the styled element whose lookless template this styled element is part of. Inherited from StyledElement. |
| Theme | Gets or sets the theme to be applied to the element. Inherited from StyledElement. |
| Transitions | Gets or sets the property transitions for the control. Inherited from Animatable. |
| UseLayoutRounding | Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable. |
| VerticalAlignment | Gets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable. |
| Width | Gets or sets the width of the element. Inherited from Layoutable. |
| ZIndex | Gets or sets the Z index of the control. Inherited from Visual. |
BarHeight Property
Gets or sets the height of the navigation bar.
public double BarHeight { get; set; }
CanGoBack Property
Gets whether the navigation stack has more than one entry.
public bool CanGoBack { get; set; }
Content Property
Gets or sets the root page of the navigation stack.
public object Content { get; set; }
EffectiveBarHeight Property
Gets the effective navigation bar height.
public double EffectiveBarHeight { get; set; }
HasShadow Property
Gets or sets whether the navigation bar has a shadow.
public bool HasShadow { get; set; }
IsBackButtonEffectivelyVisible Property
Gets the effective back-button visibility.
public bool IsBackButtonEffectivelyVisible { get; set; }
IsBackButtonVisible Property
Gets or sets whether the back button is globally visible for this NavigationPage.
public bool IsBackButtonVisible { get; set; }
IsGestureEnabled Property
Gets or sets whether edge-swipe gestures can be used to navigate back.
public bool IsGestureEnabled { get; set; }
IsNavigating Property
Gets whether a navigation operation is currently in progress.
public bool IsNavigating { get; set; }
ModalStack Property
Gets the current modal stack. Index 0 is the oldest (bottom-most) modal; the last index is the most recently pushed (topmost) modal.
public System.Collections.Generic.IReadOnlyList<Avalonia.Controls.Page> ModalStack { get; set; }
ModalTransition Property
Gets or sets the transition used when presenting or dismissing modal pages.
public Avalonia.Animation.IPageTransition ModalTransition { get; set; }
NavigationStack Property
Gets the current navigation stack as a read-only list.
public System.Collections.Generic.IReadOnlyList<Avalonia.Controls.Page> NavigationStack { get; set; }
PageTransition Property
Gets or sets the transition used when pushing or popping pages.
public Avalonia.Animation.IPageTransition PageTransition { get; set; }
StackDepth Property
Gets the number of pages in the navigation stack.
public int StackDepth { get; set; }
Fields
BackButtonContentProperty Field
Defines the Avalonia.Controls.NavigationPage.BackButtonContentProperty attached property.
public Avalonia.AttachedProperty<object> BackButtonContentProperty
BarHeightOverrideProperty Field
Defines the Avalonia.Controls.NavigationPage.BarHeightOverrideProperty attached property.
public Avalonia.AttachedProperty<Nullable<double>> BarHeightOverrideProperty
BarHeightProperty Field
Defines the Avalonia.Controls.NavigationPage.BarHeight property.
public Avalonia.StyledProperty<double> BarHeightProperty
BarLayoutBehaviorProperty Field
Defines the Avalonia.Controls.NavigationPage.BarLayoutBehaviorProperty attached property.
public Avalonia.AttachedProperty<Nullable<Avalonia.Controls.BarLayoutBehavior>> BarLayoutBehaviorProperty
BottomCommandBarProperty Field
Defines the Avalonia.Controls.NavigationPage.BottomCommandBarProperty attached property.
public Avalonia.AttachedProperty<Avalonia.Controls.Control> BottomCommandBarProperty
CanGoBackProperty Field
Defines the Avalonia.Controls.NavigationPage.CanGoBack property.
public Avalonia.DirectProperty<Avalonia.Controls.NavigationPage, bool> CanGoBackProperty
ContentProperty Field
Defines the Avalonia.Controls.NavigationPage.Content property.
public Avalonia.StyledProperty<object> ContentProperty
EffectiveBarHeightProperty Field
Defines the Avalonia.Controls.NavigationPage.EffectiveBarHeight property.
public Avalonia.DirectProperty<Avalonia.Controls.NavigationPage, double> EffectiveBarHeightProperty
HasBackButtonProperty Field
Defines the Avalonia.Controls.NavigationPage.HasBackButtonProperty attached property.
public Avalonia.AttachedProperty<bool> HasBackButtonProperty
HasNavigationBarProperty Field
Defines the Avalonia.Controls.NavigationPage.HasNavigationBarProperty attached property.
public Avalonia.AttachedProperty<bool> HasNavigationBarProperty
HasShadowProperty Field
Defines the Avalonia.Controls.NavigationPage.HasShadow property.
public Avalonia.StyledProperty<bool> HasShadowProperty
IsBackButtonEffectivelyVisibleProperty Field
Defines the Avalonia.Controls.NavigationPage.IsBackButtonEffectivelyVisible property.
public Avalonia.DirectProperty<Avalonia.Controls.NavigationPage, bool> IsBackButtonEffectivelyVisibleProperty
IsBackButtonEnabledProperty Field
Defines the Avalonia.Controls.NavigationPage.IsBackButtonEnabledProperty attached property.
public Avalonia.AttachedProperty<bool> IsBackButtonEnabledProperty
IsBackButtonVisibleProperty Field
Defines the Avalonia.Controls.NavigationPage.IsBackButtonVisible property.
public Avalonia.StyledProperty<bool> IsBackButtonVisibleProperty
IsGestureEnabledProperty Field
Defines the Avalonia.Controls.NavigationPage.IsGestureEnabled property.
public Avalonia.StyledProperty<bool> IsGestureEnabledProperty
IsNavigatingProperty Field
Defines the Avalonia.Controls.NavigationPage.IsNavigating property.
public Avalonia.DirectProperty<Avalonia.Controls.NavigationPage, bool> IsNavigatingProperty
ModalTransitionProperty Field
Defines the Avalonia.Controls.NavigationPage.ModalTransition property.
public Avalonia.StyledProperty<Avalonia.Animation.IPageTransition> ModalTransitionProperty
PageTransitionProperty Field
Defines the Avalonia.Controls.NavigationPage.PageTransition property.
public Avalonia.StyledProperty<Avalonia.Animation.IPageTransition> PageTransitionProperty
TopCommandBarProperty Field
Defines the Avalonia.Controls.NavigationPage.TopCommandBarProperty attached property.
public Avalonia.AttachedProperty<Avalonia.Controls.Control> TopCommandBarProperty
Events
| Name | Description |
|---|---|
| ActualThemeVariantChanged | Raised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement. |
| AttachedToLogicalTree | Raised when the styled element is attached to a rooted logical tree. Inherited from StyledElement. |
| AttachedToVisualTree | Raised when the control is attached to a rooted visual tree. Inherited from Visual. |
| ContextCanceled | Occurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement. |
| ContextRequested | Occurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement. |
| CurrentPageChanged | Occurs when the Avalonia.Controls.Page.CurrentPage property changes. Inherited from MultiPage. |
| DataContextChanged | Occurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement. |
| DetachedFromLogicalTree | Raised when the styled element is detached from a rooted logical tree. Inherited from StyledElement. |
| DetachedFromVisualTree | Raised when the control is detached from a rooted visual tree. Inherited from Visual. |
| DoubleTapped | Occurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement. |
| EffectiveViewportChanged | Occurs when the element's effective viewport changes. Inherited from Layoutable. |
| GettingFocus | Occurs before the control receives focus. Inherited from InputElement. |
| GotFocus | Occurs when the control receives focus. Inherited from InputElement. |
| Holding | Occurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact. Inherited from InputElement. |
| Initialized | Occurs when the styled element has finished initialization. Inherited from StyledElement. |
| KeyDown | Occurs when a key is pressed while the control has focus. Inherited from InputElement. |
| KeyUp | Occurs when a key is released while the control has focus. Inherited from InputElement. |
| LayoutUpdated | Occurs when a layout pass completes for the control. Inherited from Layoutable. |
| Loaded | Occurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control. |
| LosingFocus | Occurs before the control loses focus. Inherited from InputElement. |
| LostFocus | Occurs when the control loses focus. Inherited from InputElement. |
| ModalPopped | Occurs when a modal page is popped. |
| ModalPushed | Occurs when a modal page is pushed. |
| NavigatedFrom | Occurs when the page has been navigated from. Inherited from Page. |
| NavigatedTo | Occurs when the page has been navigated to. Inherited from Page. |
| Navigating | Occurs when the page is about to be navigated from. Inherited from Page. |
| PageInserted | Occurs when a page has been inserted into the navigation stack. |
| PageNavigationSystemBackButtonPressed | Raised when the system back button is pressed while this page is active. Inherited from Page. |
| PageRemoved | Occurs when a page has been removed from the navigation stack. |
| PagesChanged | Occurs when the Avalonia.Controls.MultiPage.Pages collection changes. Inherited from MultiPage. |
| Pinch | Occurs when the user moves two contact points closer together. Inherited from InputElement. |
| PinchEnded | Occurs when the user releases both contact points used in a pinch gesture. Inherited from InputElement. |
| PointerCaptureLost | Occurs when the control or its child control loses the pointer capture for any reason, event will not be triggered for a parent control if capture was transferred to another child of that parent control. Inherited from InputElement. |
| PointerEntered | Occurs when the pointer enters the control. Inherited from InputElement. |
| PointerExited | Occurs when the pointer leaves the control. Inherited from InputElement. |
| PointerMoved | Occurs when the pointer moves over the control. Inherited from InputElement. |
| PointerPressed | Occurs when the pointer is pressed over the control. Inherited from InputElement. |
| PointerReleased | Occurs when the pointer is released over the control. Inherited from InputElement. |
| PointerTouchPadGestureMagnify | Occurs when the user moves two contact points away from each other on a touchpad. Inherited from InputElement. |
| PointerTouchPadGestureRotate | Occurs when the user places two contact points and moves them in a circular motion on a touchpad. Inherited from InputElement. |
| PointerTouchPadGestureSwipe | Occurs when the user performs a rapid dragging motion in a single direction on a touchpad. Inherited from InputElement. |
| PointerWheelChanged | Occurs when the mouse is scrolled over the control. Inherited from InputElement. |
| Popped | Occurs when a page is popped from the navigation stack. |
| PoppedToRoot | Occurs when the stack is popped to root. |
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |
| PullGesture | Occurs when the user drags from the edge of a control. Inherited from InputElement. |
| PullGestureEnded | Occurs when the user releases the pointer after a pull gesture. Inherited from InputElement. |
| Pushed | Occurs when a page is pushed onto the navigation stack. |
| ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement. |
| RightTapped | Occurs when the user briefly contacts and releases a single point, without significant movement, using a mechanism on the input device recognized as a right button or equivalent. Inherited from InputElement. |
| ScrollGesture | Occurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement. |
| ScrollGestureEnded | Occurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer. Inherited from InputElement. |
| ScrollGestureInertiaStarting | Occurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement. |
| SizeChanged | Occurs when the bounds (actual size) of the control have changed. Inherited from Control. |
| SwipeGesture | Occurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement. |
| SwipeGestureEnded | Occurs when a swipe gesture ends on the control. Inherited from InputElement. |
| Tapped | Occurs when the user briefly contacts and releases a single point, without significant movement. Inherited from InputElement. |
| TemplateApplied | Raised when the control's template is applied. Inherited from TemplatedControl. |
| TextInput | Occurs when a user typed some text while the control has focus. Inherited from InputElement. |
| TextInputMethodClientRequested | Occurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement. |
| Unloaded | Occurs when the control is removed from the visual tree. Inherited from Control. |
ModalPopped Event
Occurs when a modal page is popped.
public event EventHandler<Avalonia.Controls.ModalPoppedEventArgs> ModalPopped
ModalPushed Event
Occurs when a modal page is pushed.
public event EventHandler<Avalonia.Controls.ModalPushedEventArgs> ModalPushed
PageInserted Event
Occurs when a page has been inserted into the navigation stack.
public event EventHandler<Avalonia.Controls.PageInsertedEventArgs> PageInserted
PageRemoved Event
Occurs when a page has been removed from the navigation stack.
public event EventHandler<Avalonia.Controls.PageRemovedEventArgs> PageRemoved
Popped Event
Occurs when a page is popped from the navigation stack.
public event EventHandler<Avalonia.Controls.NavigationEventArgs> Popped
PoppedToRoot Event
Occurs when the stack is popped to root.
public event EventHandler<Avalonia.Controls.NavigationEventArgs> PoppedToRoot
Remarks
The Avalonia.Controls.NavigationEventArgs.Page property holds the root page that is now current, not any of the pages that were popped. To observe each popped page individually, subscribe to Avalonia.Controls.NavigationPage.Popped.
Pushed Event
Occurs when a page is pushed onto the navigation stack.
public event EventHandler<Avalonia.Controls.NavigationEventArgs> Pushed