NavigationViewItem Class

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Represents the container for an item in a NavigationView control.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
class NavigationViewItem : NavigationViewItemBase

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public class NavigationViewItem : NavigationViewItemBase

Public Class NavigationViewItem
Inherits NavigationViewItemBase

<NavigationViewItem .../>

Inheritance

ContentControl

NavigationViewItemBase

NavigationViewItem

Attributes

MarshalingBehaviorAttribute ThreadingAttribute ContractVersionAttribute

Examples

Tip

For more info, design guidance, and code examples, see Navigation view.

Open the WinUI 2 Gallery app and see the NavigationView in action.

The WinUI 2 Gallery app includes interactive examples of most WinUI 2 controls, features, and functionality. Get the app from the Microsoft Store or get the source code on GitHub.

Remarks

Note that you can only place NavigationViewItems in NavigationView.MenuItems.

Constructors

NavigationViewItem()

Initializes a new instance of the NavigationViewItem class. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Properties

CompactPaneLength	Gets the CompactPaneLength of the NavigationView that hosts this item. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
CompactPaneLengthProperty	Identifies the CompactPaneLength dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HasUnrealizedChildren	Gets or sets a value that indicates whether the current item has child items that haven't been shown. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HasUnrealizedChildrenProperty	Identifies the HasUnrealizedChildren dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Icon	Gets or sets the icon to show next to the menu item text. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IconProperty	Identifies the Icon dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
InfoBadge	Gets or sets the InfoBadge object to display on the NavigationViewItem. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
InfoBadgeProperty	Identifies the InfoBadge dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsChildSelected	Gets or sets the value that indicates whether or not descendant item is selected. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsChildSelectedProperty	Identifies the IsChildSelected dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsExpanded	Gets or sets a value that indicates whether a tree node is expanded. Ignored if there are no menu items. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsExpandedProperty	Identifies the IsExpanded dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsSelected	Gets or sets the value that indicates whether a NavigationViewItem is selected. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (Inherited from NavigationViewItemBase)
MenuItems	Gets the collection of menu items displayed as children of the NavigationViewItem. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
MenuItemsProperty	Identifies the MenuItems dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
MenuItemsSource	Gets or sets an object source used to generate the children of the NavigationViewItem. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
MenuItemsSourceProperty	Identifies the MenuItemsSource dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SelectsOnInvoked	Gets or sets a value that indicates whether invoking a navigation menu item also selects it. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SelectsOnInvokedProperty	Identifies the SelectsOnInvoked dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).