INavigationView interface¶
Defined in
Namespace: CrissCross.Avalonia.UI.Controls
Assembly: CrissCross.Avalonia.UI.dll
Full name: CrissCross.Avalonia.UI.Controls.INavigationView
Modifiers: public abstract
Summary¶
Represents a container that enables navigation of app content. It has a header, a view for the main content, and a menu pane for navigation commands.
Applies to
net10.0, net10.0-browserwasm1.0, net10.0-desktop1.0, net9.0, net9.0-browserwasm1.0, net9.0-desktop1.0, net8.0, net8.0-ios17.5, net8.0-maccatalyst17.5, net8.0-macos14.2, net8.0-macos14.5, net8.0-tvos17.2, netstandard2.1, net471
Properties¶
| Name | Summary |
|---|---|
| Header | Gets or sets the header content. |
| HeaderVisibility | Gets or sets a value indicating whether the [Header](# is visible. |
| AlwaysShowHeader | Gets or sets a value indicating whether gets or sets a value that indicates whether the header is always visible. |
| MenuItems | Gets the collection of menu items displayed in the NavigationView. |
| MenuItemsSource | Gets or sets an object source used to generate the content of the NavigationView menu. |
| FooterMenuItems | Gets the list of objects to be used as navigation items in the footer menu. |
| FooterMenuItemsSource | Gets or sets the object that represents the navigation items to be used in the footer menu. |
| SelectedItem | Gets the selected item. |
| ContentOverlay | Gets or sets a UI element that is shown at the top of the control, below the pane if PaneDisplayMode is Top. |
| IsBackEnabled | Gets a value indicating whether gets a value that indicates whether the back button is enabled or disabled. |
| IsBackButtonVisible | Gets or sets a value that indicates whether the back button is visible or not. Default value is "Auto", which indicates that button visibility depends on the DisplayMode setting of the... |
| IsPaneToggleVisible | Gets or sets a value indicating whether gets or sets a value that indicates whether the toggle button is visible. |
| IsPaneOpen | Gets or sets a value indicating whether gets or sets a value that specifies whether the NavigationView pane is expanded to its full width. |
| IsPaneVisible | Gets or sets a value indicating whether gets or sets a value that determines whether the pane is shown. |
| OpenPaneLength | Gets or sets the width of the NavigationView pane when it's fully expanded. |
| CompactPaneLength | Gets or sets the width of the NavigationView pane in its compact display mode. |
| PaneHeader | Gets or sets the content for the pane header. |
| PaneTitle | Gets or sets the label adjacent to the menu icon when the NavigationView pane is open. |
| PaneFooter | Gets or sets the content for the pane footer. |
| PaneDisplayMode | Gets or sets a value that specifies how the pane and content areas of a NavigationView are being shown. |
| TitleBar | Gets or sets an TitleBar to be displayed in the NavigationView. |
| AutoSuggestBox | Gets or sets an AutoSuggestBox to be displayed in the NavigationView. |
| BreadcrumbBar | Gets or sets an BreadcrumbBar that is in [Header](# |
| ItemTemplate | Gets or sets template Property for [MenuItems](# and [FooterMenuItems](# |
| TransitionDuration | Gets or sets a value deciding how long the effect of the transition between the pages should take. |
| Transition | Gets or sets type of [INavigationView](# transitions during navigation. |
| FrameMargin | Gets or sets margin for a Frame of [INavigationView](# |
| CanGoBack | Gets a value indicating whether gets a value that indicates whether there is at least one entry in back navigation history. |
| CanGoForward | Gets a value indicating whether there is at least one entry in forward navigation history. |
Methods¶
| Name | Summary |
|---|---|
| Navigate | Synchronously navigates current navigation Frame to the given Element. |
| NavigateWithHierarchy | Synchronously adds an element to the navigation stack and navigates current navigation Frame to the. |
| ReplaceContent | Replaces the contents of the navigation frame, without changing the currently selected item or triggering an [SelectionChanged](# |
| GoForward | Navigates the NavigationView to the next journal entry. |
| GoBack | Navigates the NavigationView to the previous journal entry. |
| ClearJournal | Clears the NavigationView history. |
| SetPageService | Allows you to assign to the NavigationView a special service responsible for retrieving the page instances. |
| SetServiceProvider | Allows you to assign a general IServiceProvider to the NavigationView that will be used to retrieve page instances and view models. |
Events¶
| Name | Summary |
|---|---|
| PaneOpened | Occurs when the NavigationView pane is opened. |
| PaneClosed | Occurs when the NavigationView pane is closed. |
| SelectionChanged | Occurs when the currently selected item changes. |
| ItemInvoked | Occurs when an item in the menu receives an interaction such as a click or tap. |
| BackRequested | Occurs when the back button receives an interaction such as a click or tap. |
| Navigating | Occurs when a new navigation is requested. |
| Navigated | Occurs when navigated to page. |