NavBarGroup.Header Property

Gets or sets the content of the group’s header. This is a dependency property.

Namespace: DevExpress.Xpf.NavBar

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

NuGet Package: DevExpress.Wpf.NavBar

Declaration

C#

public object Header { get; set; }

VB.NET

Public Property Header As Object

Property Value

Type	Description
Object	The object to use for the group header.

Remarks

You can set the Header property to a string or any other object. In the latter case, you can provide a template to render this object via the NavBarGroup.HeaderTemplate and NavBarGroup.HeaderTemplateSelector or the NavBarViewBase.HeaderTemplate and NavBarViewBase.HeaderTemplateSelector properties.

To learn more, see the Group Content Model 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.

View Example

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 Header 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.

XAML

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

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

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

<dxn:NavBarControl.Groups>
    <dxn:NavBarGroup Header="Group_1">
        <dxn:NavBarGroup.Items>

how-to-iterate-through-groups-and-toggle-their-expanded-state-e1622/CS/ToggleGroupExpandedState/Window1.xaml#L7

<dxn:NavBarControl.Groups>
    <dxn:NavBarGroup Header="Group1">
        <dxn:NavBarItem>Item1</dxn:NavBarItem>

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

<dxn:NavBarControl.Groups>
    <dxn:NavBarGroup Header="Some Group 1">
        <dxn:NavBarItem Content="Item 1"/>

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

</dxn:NavBarControl.View>
<dxn:NavBarGroup Header="Navigation items" DisplaySource="Items">
    <dxn:NavBarGroup.Items>

C#

how-to-programmatically-create-a-navbarcontrol-with-groups-and-items-e1626/CS/CreateNavBarControlViaCode/Window1.xaml.cs#L43

NavBarGroup group1 = new NavBarGroup();
group1.Header = "Items";
//Display an image within the group's header

VB.NET

how-to-programmatically-create-a-navbarcontrol-with-groups-and-items-e1626/VB/CreateNavBarControlViaCode/Window1.xaml.vb#L34

Dim group1 As NavBarGroup = New NavBarGroup()
group1.Header = "Items"
'Display an image within the group's header