NavGroupCollection.Add() Method

Adds a new group to the end of the collection and returns the corresponding object.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v19.1.dll

Declaration

C#

public virtual NavBarGroup Add()

VB.NET

Public Overridable Function Add As NavBarGroup

Returns

Type	Description
NavBarGroup	A NavBarGroup object representing the newly created group.

Remarks

Use the Add method to add a new group to the NavBarControl. Modify properties of the obtained object to control the appearance and behavior of the added group.

You can access the collection of group links via the NavBarGroup.ItemLinks property. Use the NavLinkCollection.Add method of the obtained collection to add links to the group.

Example

The following sample code demonstrates how to add and modify groups, items and links between them. All elements are added via the Add method of the corresponding collection.

Captions are assigned to the added group and two items. This is performed via the NavElement.Caption property of the NavBarGroup and NavBarItem objects respectively. The NavElement.SmallImage property is used to display images within links.

The following image displays the control before and after code execution.

C#

using DevExpress.XtraNavBar;
// ...
// adding and adjusting a new group 
NavBarGroup helpGroup = navBarControl1.Groups.Add();
helpGroup.Caption = "Help Topics";
helpGroup.LinksUseSmallImage = true;

// adding and adjusting two items
NavBarItem indexItem = navBarControl1.Items.Add();
indexItem.Caption = "Index";
indexItem.SmallImage = Image.FromFile("E:\\Images\\Icons\\index.bmp");

NavBarItem contentsItem = navBarControl1.Items.Add();
contentsItem.Caption = "Contents";
contentsItem.SmallImage = Image.FromFile("E:\\Images\\Icons\\bookclosed.bmp");

// creating links between the group and items
helpGroup.ItemLinks.Add(indexItem);
helpGroup.ItemLinks.Add(contentsItem);

VB.NET

Imports DevExpress.XtraNavBar
' ...
' adding and adjusting a new group 
Dim HelpGroup As NavBarGroup = NavBarControl1.Groups.Add
HelpGroup.Caption = "Help Topics"
HelpGroup.LinksUseSmallImage = True

' adding and adjusting two items
Dim IndexItem As NavBarItem = NavBarControl1.Items.Add
IndexItem.Caption = "Index"
IndexItem.SmallImage = Image.FromFile("E:\Images\Icons\index.bmp")

Dim ContentsItem As NavBarItem = NavBarControl1.Items.Add
ContentsItem.Caption = "Contents"
ContentsItem.SmallImage = Image.FromFile("E:\Images\Icons\bookclosed.bmp")

' creating links between the group and items
HelpGroup.ItemLinks.Add(IndexItem)
HelpGroup.ItemLinks.Add(ContentsItem)

Related GitHub Examples

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

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-hide-the-group-header-of-a-navigation-pane-e1005/CS/Form1.cs#L113

NavBarGroup group = navBarControl1.Groups.Add();
group.GroupCaptionUseImage = NavBarImage.Small;

how-to-programmatically-create-a-controlcontainer-group-e887/CS/Form1.cs#L107

Control innerControl = new UserControl1();
NavBarGroup group = navBarControl1.Groups.Add();
group.GroupStyle = NavBarGroupStyle.ControlContainer;

how-to-scroll-the-explorer-view-programmatically-e806/CS/ScrollGroups/Form1.cs#L24

for(int i = 0; i < GroupCount; i++) {
    NavBarGroup group = navBarControl1.Groups.Add();
    group.Caption = "Group " + i.ToString();

VB.NET

how-to-hide-the-group-header-of-a-navigation-pane-e1005/VB/Form1.vb#L105

Dim group As NavBarGroup = navBarControl1.Groups.Add()
group.GroupCaptionUseImage = NavBarImage.Small

how-to-programmatically-create-a-controlcontainer-group-e887/VB/Form1.vb#L100

Dim innerControl As Control = New UserControl1()
Dim group As NavBarGroup = navBarControl1.Groups.Add()
group.GroupStyle = NavBarGroupStyle.ControlContainer

how-to-scroll-the-explorer-view-programmatically-e806/VB/ScrollGroups/Form1.vb#L26

For i As Integer = 0 To GroupCount - 1
    Dim group As NavBarGroup = navBarControl1.Groups.Add()
    group.Caption = "Group " & i.ToString()