NavBarItem Class

Represents an individual item within the NavBarControl control.

Namespace: DevExpress.Xpf.NavBar

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

Declaration

public class NavBarItem :
    DXFrameworkContentElement,
    IClickable
Public Class NavBarItem
    Inherits DXFrameworkContentElement
    Implements IClickable

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.

Examples

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.

View Example

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);
}
See Also