NavigationView class¶

Attributes: [ToolboxItem(true)] [ToolboxBitmap] [TemplatePart] [TemplatePart] [TemplatePart] [TemplatePart] [TemplatePart] [TemplatePart]

Defined in

Namespace: CrissCross.WPF.UI.Controls Assembly: CrissCross.WPF.UI.dll Full name: CrissCross.WPF.UI.Controls.NavigationView Modifiers: public

Summary¶

Partial ViewModel-first integration for NavigationView. Enables automatic activation/highlighting of items when ViewModel-based navigation occurs via CrissCross navigation hosts.

Applies to

net10.0-windows10.0.19041, net9.0-windows10.0.19041, net8.0-windows10.0.19041, net481

Class hierarchy

classDiagram
class NavigationView
class Control
Control <|-- NavigationView
class INavigationView {
    <>
}
INavigationView <|.. NavigationView
class IUseHostedNavigation {
    <>
}
IUseHostedNavigation <|.. NavigationView
class IDisposable {
    <>
}
IDisposable <|.. NavigationView

Inherits from: Control

Implements: INavigationView, IUseHostedNavigation, IDisposable

Constructors¶

Name	Summary
.ctor	Initializes a new instance of the [NavigationView](# class.

Properties¶

Name	Summary
SelectedItem	Gets the selected item.
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.
EnableDebugMessages	Gets or sets a value indicating whether enables or disables debugging messages for this control.
Header	Gets or sets the header content.
HeaderVisibility	Gets or sets the [Header](# visibility.
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.
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.
AutoSuggestBox	Gets or sets an AutoSuggestBox to be displayed in the NavigationView.
TitleBar	Gets or sets an TitleBar 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](#

Fields¶

Name	Summary
static HeaderContentProperty	The header content property.
static PaneOpenedEvent	Property for [PaneOpened](#
static PaneClosedEvent	Property for [PaneClosed](#
static SelectionChangedEvent	Property for [SelectionChanged](#
static ItemInvokedEvent	Property for [ItemInvoked](#
static BackRequestedEvent	Property for [BackRequested](#
static NavigatingEvent	Property for [Navigating](#
static NavigatedEvent	Property for [NavigatedEvent](#
static EnableDebugMessagesProperty	Property for [Header](#
static HeaderProperty	Property for [Header](#
static HeaderVisibilityProperty	Property for [HeaderVisibility](#
static AlwaysShowHeaderProperty	Property for [AlwaysShowHeader](#
static MenuItemsProperty	Identifies the [MenuItems](# dependency property.
static FooterMenuItemsProperty	Identifies the [FooterMenuItems](# dependency property.
static MenuItemsSourceProperty	Property for [MenuItemsSource](#
static FooterMenuItemsSourceProperty	Property for [FooterMenuItemsSource](#
static ContentOverlayProperty	Property for [ContentOverlay](#
static IsBackEnabledProperty	Property for [IsBackEnabled](#
static IsBackButtonVisibleProperty	Property for [IsBackButtonVisible](#
static IsPaneToggleVisibleProperty	Property for [IsPaneToggleVisible](#
static IsPaneOpenProperty	Property for [IsPaneOpen](#
static IsPaneVisibleProperty	Property for [IsPaneVisible](#
static OpenPaneLengthProperty	Property for [OpenPaneLength](#
static CompactPaneLengthProperty	Property for [CompactPaneLength](#
static PaneHeaderProperty	Property for [PaneHeader](#
static PaneTitleProperty	Property for [PaneTitle](#
static PaneFooterProperty	Property for [PaneFooter](#
static PaneDisplayModeProperty	Property for [PaneDisplayMode](#
static AutoSuggestBoxProperty	Property for [AutoSuggestBox](#
static TitleBarProperty	Property for [TitleBar](#
static BreadcrumbBarProperty	Property for [BreadcrumbBar](#
static ItemTemplateProperty	Property for [ItemTemplate](#
static TransitionDurationProperty	Property for [TransitionDuration](#
static TransitionProperty	Property for [Transition](#
static FrameMarginProperty	Property for [FrameMargin](#
NavigationViewContentPresenter	Control responsible for rendering the content.
MenuItemsItemsControl	Control located at the top of the pane with left arrow icon.
FooterMenuItemsItemsControl	Control located at the top of the pane with hamburger icon.
BackButton	Control located at the top of the pane with left arrow icon.
ToggleButton	Control located at the top of the pane with hamburger icon.
AutoSuggestBoxSymbolButton	Control that is visitable if PaneDisplayMode="Left" and in compact state.

Methods¶

Name	Summary
static GetHeaderContent	Gets the content of the header.
static SetHeaderContent	Sets the content of the header.
static UpdateVisualState	Updates the state of the visual.
OnInitialized
OnUnloaded	This virtual method is called when this element is detached form a loaded tree.
OnMouseDown	Invoked when an unhandled MouseDown�attached event reaches an element in its route that is derived from this class....
OnSizeChanged	This virtual method is called when ActualWidth or ActualHeight (or both) changed.
OnBackButtonClick	This virtual method is called when [BackButton](# is clicked.
OnToggleButtonClick	This virtual method is called when [ToggleButton](# is clicked.
AutoSuggestBoxSymbolButtonOnClick	This virtual method is called when [AutoSuggestBoxSymbolButton](# is clicked.
OnPaneDisplayModeChanged	This virtual method is called when [PaneDisplayMode](# is changed.
OnItemTemplateChanged	This virtual method is called when [ItemTemplate](# is changed.
BreadcrumbBarOnItemClicked	Breadcrumbs the bar on item clicked.
AddItemsToDictionaries	Adds the items to dictionaries.
AddItemsToAutoSuggestBoxItems	Adds the items to automatic suggest box items.
NavigateToMenuItemFromAutoSuggestBox	Navigates to menu item from automatic suggest box.
UpdateMenuItemsTemplate	Updates the menu items template.
CloseNavigationViewItemMenus	Closes the navigation view item menus.
DeactivateMenuItems	Deactivates the menu items.
OnPaneOpened	Raises the pane opened event.
OnPaneClosed	Raises the pane closed event.
OnSelectionChanged	Raises the selection changed event.
OnItemInvoked	Raises the item invoked event.
OnBackRequested	Raises the back requested event.
OnNavigating	Raises the navigating requested event.
OnNavigated	Raises the navigated requested event.
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.
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.
OnApplyTemplate
GetTemplateChild	Gets the template child.
Dispose	Disposes resources.

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

Inherited members