Back to Devexpress

NavLinkCollection.Add(NavBarItem) Method

windowsforms-devexpress-dot-xtranavbar-dot-navlinkcollection-dot-add-x28-devexpress-dot-xtranavbar-dot-navbaritem-x29.md

latest4.5 KB
Original Source

NavLinkCollection.Add(NavBarItem) Method

Adds a link to the end of the collection.

Namespace : DevExpress.XtraNavBar

Assembly : DevExpress.XtraNavBar.v25.2.dll

NuGet Package : DevExpress.Win

Declaration

csharp
public virtual NavBarItemLink Add(
    NavBarItem item
)
vb
Public Overridable Function Add(
    item As NavBarItem
) As NavBarItemLink

Parameters

NameTypeDescription
itemNavBarItem

A NavBarItem object to which the created link refers.

|

Returns

TypeDescription
NavBarItemLink

A NavBarItemLink object representing the added link.

|

Remarks

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

You can access the collection of group links via the NavBarGroup.ItemLinks property. Groups are obtained via the control’s NavBarControl.Groups property.

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.ImageOptions property is used to display images within links.

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

csharp
using DevExpress.XtraNavBar;
// ...
// Create a new group 
NavBarGroup helpGroup = navBarControl1.Groups.Add();
helpGroup.Caption = "Help Topics";
helpGroup.GroupStyle = NavBarGroupStyle.SmallIconsText;

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

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

// Add the items to the group
helpGroup.ItemLinks.Add(indexItem);
helpGroup.ItemLinks.Add(contentsItem);
vb
Imports DevExpress.XtraNavBar
' ...
' Create a new group 
Dim HelpGroup As NavBarGroup = NavBarControl1.Groups.Add
HelpGroup.Caption = "Help Topics"
HelpGroup.GroupStyle = NavBarGroupStyle.SmallIconsText

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

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

' Add the items to the group
HelpGroup.ItemLinks.Add(IndexItem)
HelpGroup.ItemLinks.Add(ContentsItem)

See Also

Groups

ItemLinks

AddRange(NavBarItemLink[])

Insert(Int32, ICollectionItem)

NavLinkCollection Class

NavLinkCollection Members

DevExpress.XtraNavBar Namespace