NavBarGroup.Items Property

Gets the collection of items within the group and provides indexed access to them.

Namespace: DevExpress.Xpf.NavBar

Assembly: DevExpress.Xpf.NavBar.v19.1.dll

Declaration

C#

public NavBarItemCollection Items { get; }

VB.NET

Public ReadOnly Property Items As NavBarItemCollection

Property Value

Type	Description
NavBarItemCollection	A NavBarItemCollection object representing the collection of the group’s items.

Remarks

If a group’s NavBarGroup.DisplaySource property is set to DisplaySource.Items, the content of the group’s client region is defined using the Items property. This property provides access to a collection that contains all the items of the current group. This collection provides a standard means to manipulate (add or remove) items within a group. A particular item can be accessed using index notation.

Note

The NavBarGroup.Items property is, by design, specified as the default property and the content property of a group. This, for example, allows you to declare items in XAML directly after a group declaration, without wrapping them into opening and closing NavBarGroup.Items tags.

See the Group Content Model topic to learn more.

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 Items property.

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#L48

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

how-to-navigate-through-views-by-using-navbarcontrol-control-and-navigationframe-class-e5129/CS/DXSample/MainWindow.xaml#L33

<dxn:NavBarGroup Header="Navigation items" DisplaySource="Items">
    <dxn:NavBarGroup.Items>
        <dxn:NavBarItem Command="{Binding GoToUserControl1Command}">Go to UserControl1</dxn:NavBarItem>

how-to-wrap-long-text-of-the-navigation-bars-items-e1013/VB/Window1.xaml#L13

<dxn:NavBarGroup Header="Group1">
    <dxn:NavBarGroup.Items>
        <dxn:NavBarItem Content="VeryVeryVeryVeryVeryVeryLongText1" />