NavBarItem Class

Represents an individual item within the NavBarControl control.

Namespace: DevExpress.Xpf.NavBar

Assembly: DevExpress.Xpf.NavBar.v18.2.dll

Declaration

C#

public class NavBarItem :
    DXFrameworkContentElement,
    IClickable

VB.NET

Public Class NavBarItem
    Inherits DXFrameworkContentElement
    Implements IClickable

Related API Members

The following members return NavBarItem objects:

• ItemAddingEventArgs.Item
• NavBarGroup.SelectedItem
• NavBarItemSelectedEventArgs.Item
• NavBarItemSelectingEventArgs.NewItem
• NavBarItemSelectingEventArgs.PrevItem
• NavBarViewBase.GetNavBarItem(RoutedEventArgs)

Remarks

The NavBarItem class implements the functionality of an individual navbar item within the NavBarControl. Items are represented by instances of the NavBarItem class which can be accessed via the NavBarGroup.Items property of a group. This property returns the NavBarItemCollection collection which allows you to add and delete items within a group.

Use properties of the NavBarItem class to specify the appearance and behavior of an individual item. You can define the NavBarItem.Content and NavBarItem.ImageSource properties to specify an item’s caption text and image displayed in the item. An item’s visibility and availability to end-users can be controlled via the NavBarItem.IsVisible and DXFrameworkContentElement.IsEnabled properties.

Use the NavBarItem.IsSelected property to determine the selected state of an item.

Using the NavBarItem.VisualStyle property, you can define a visual style to be applied to an item.

To learn more, see the Items topic.

Example

This example demonstrates how items can be created and customized programmatically within a navbar group.

In this sample, images are defined for the group header and the third group item via the NavBarGroup.ImageSource and NavBarItem.ImageSource properties, respectively. The item image’s layout is customized by assigning the item’s NavBarItem.VisualStyle property with a specific style that makes use of the NavBarViewBase.LayoutSettings attached property’s LayoutSettings.ImageDocking setting.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-programmatically-create-a-navbarcontrol-with-groups-and-items-e1626.

Window1.xaml.cs

private void CreateGroup1(NavBarControl navBar){
    NavBarGroup group1 = new NavBarGroup();
    group1.Header = "Items";
    //Display an image within the group's header
    group1.ImageSource = new BitmapImage(new Uri("pack://application:,,,/Images/folder.png"));

    NavBarItem item1 = new NavBarItem();
    item1.Content = "Home";
    group1.Items.Add(item1);

    NavBarItem item2 = new NavBarItem();
    item2.Content = "Work";
    group1.Items.Add(item2);

    NavBarItem item3 = new NavBarItem();
    item3.Content = "Private";
    //Display an image within the item
    item3.ImageSource = new BitmapImage(new Uri("pack://application:,,,/Images/private.png"));
    //Change item image layout
    Style itemStyle = new Style();
    itemStyle.Setters.Add(new Setter(NavBarViewBase.LayoutSettingsProperty, new LayoutSettings() { ImageDocking = Dock.Right }));
    item3.VisualStyle = itemStyle;
    group1.Items.Add(item3);

    navBar.Groups.Add(group1);
}

Window1.xaml.vb

Private Sub CreateGroup1(ByVal navBar As NavBarControl)
    Dim group1 As New NavBarGroup()
    group1.Header = "Items"
    'Display an image within the group's header
    group1.ImageSource = New BitmapImage(New Uri("pack://application:,,,/Images/folder.png"))

    Dim item1 As New NavBarItem()
    item1.Content = "Home"
    group1.Items.Add(item1)

    Dim item2 As New NavBarItem()
    item2.Content = "Work"
    group1.Items.Add(item2)

    Dim item3 As New NavBarItem()
    item3.Content = "Private"
    'Display an image within the item
    item3.ImageSource = New BitmapImage(New Uri("pack://application:,,,/Images/private.png"))
    'Change item image layout
    Dim itemStyle As New Style()
    itemStyle.Setters.Add(New Setter(NavBarViewBase.LayoutSettingsProperty, New LayoutSettings() With {.ImageDocking = Dock.Right}))
    item3.VisualStyle = itemStyle
    group1.Items.Add(item3)

    navBar.Groups.Add(group1)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the NavBarItem class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-provide-keyboard-navigation-in-navbar-e3809/CS/NavBarAttachedProperty.Example/MainWindow.xaml#L49

<dxn:NavBarGroup.Items>
    <dxn:NavBarItem Content="Item_1.1"/>
    <dxn:NavBarItem Content="Item_1.2"/>

how-to-synchronize-the-navbar-navigation-pane-expanded-width-with-its-popup-width-e4302/CS/NavBarSample/MainWindow.xaml#L25

<dxn:NavBarGroup Header="Group1" x:Name="firstGroup">
    <dxn:NavBarItem>Item1</dxn:NavBarItem>
</dxn:NavBarGroup>

how-to-create-a-custom-theme-for-dxnavbar-for-wpf-e1454/VB/Window1.xaml#L53

<dxn:NavBarGroup Header="Group1" ImageSource="{StaticResource groupImage}">
    <dxn:NavBarItem Content="Item1" IsEnabled="False"
                    ImageSource="{StaticResource itemImage}" />

alternative-theme-for-the-explorerbar-view-e2006/VB/Window1.xaml#L44

<dxn:NavBarGroup Header="Group1">
    <dxn:NavBarItem Content="Item1" ImageSource="{StaticResource image1}" />
    <dxn:NavBarItem Content="Item2" ImageSource="{StaticResource image2}" />

how-to-add-a-draganddrop-capability-to-navbarcontrol-t164276/CS/NavBarDragDropExample/MainWindow.xaml#L16

<dxn:NavBarGroup Header="Some Group 1">
    <dxn:NavBarItem Content="Item 1"/>
    <dxn:NavBarItem Content="Item 2"/>

Inheritance

Object

DispatcherObject

DependencyObject

ContentElement

FrameworkContentElement

DXFrameworkContentElement

NavBarItem

Extension Methods

GetErrorOperationCommands(Position)

GetErrorOperationCommands(Int32)

GetErrorOperationCommands(Point)