NavElement.Caption Property

Gets or sets the element’s caption.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v19.1.dll

Declaration

C#

[XtraSerializableProperty]
[SmartTagProperty("Caption", "Appearance", 0, SmartTagActionType.RefreshAfterExecute)]
public virtual string Caption { get; set; }

VB.NET

<XtraSerializableProperty>
<SmartTagProperty("Caption", "Appearance", 0, SmartTagActionType.RefreshAfterExecute)>
Public Overridable Property Caption As String

Property Value

Type	Description
String	A string value specifying element caption.

Remarks

If the HTML formatting feature is enabled (see NavBarControl.AllowHtmlString and NavElement.AllowHtmlString), you can use HTML tags to format the NavElement.Caption. For detailed information, see HTML Text Formatting.

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

NavBarItem item = navBarControl1.Items.Add();
item.Caption = "New Item";

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

NavBarGroup group = navBarControl1.Groups.Add();
group.Caption = "Group " + i.ToString();
group.Expanded = true;

how-to-add-the-navbarcontrol-to-the-wizardcontrol-e972/CS/Q138607/MyWizardControl.cs#L67

navBarGroup1.AddItem();
navBarGroup1.ItemLinks[navBarGroup1.ItemLinks.Count - 1].Item.Caption = page.Text;
navBarGroup1.ItemLinks[navBarGroup1.ItemLinks.Count - 1].Item.LinkClicked += new NavBarLinkEventHandler(Item_LinkClicked);

lesson-5-complex-navigation-in-mvpvm-application-t136053/CS/MvpvmNavigation/Form1.cs#L61

navGroup.Name = "navGroup" + ViewModel.GetName(moduleType);
navGroup.Caption = ViewModel.GetCaption(moduleType);
groups[i] = navGroup;

lesson-4-simple-navigation-in-mvpvm-application-t136045/CS/MvpvmNavigation/Form1.cs#L56

navGroup.Name = "navGroup" + MainFormPresenter.GetName(modules[i]);
navGroup.Caption = MainFormPresenter.GetDisplayText(modules[i]);
groups[i] = navGroup;

VB.NET

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

Dim item As NavBarItem = navBarControl1.Items.Add()
item.Caption = "New Item"

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

Dim group As NavBarGroup = navBarControl1.Groups.Add()
group.Caption = "Group " & i.ToString()
group.Expanded = True

how-to-add-the-navbarcontrol-to-the-wizardcontrol-e972/VB/Q138607/MyWizardControl.vb#L74

navBarGroup1.AddItem()
navBarGroup1.ItemLinks(navBarGroup1.ItemLinks.Count - 1).Item.Caption = page.Text
AddHandler navBarGroup1.ItemLinks(navBarGroup1.ItemLinks.Count - 1).Item.LinkClicked, AddressOf Item_LinkClicked

lesson-5-complex-navigation-in-mvpvm-application-t136053/VB/MvpvmNavigation/Form1.vb#L66

navGroup.Name = "navGroup" & ViewModel.GetName(moduleType)
navGroup.Caption = ViewModel.GetCaption(moduleType)
groups(i) = navGroup

lesson-4-simple-navigation-in-mvpvm-application-t136045/VB/MvpvmNavigation/Form1.vb#L60

navGroup.Name = "navGroup" & MainFormPresenter.GetName(modules(i))
navGroup.Caption = MainFormPresenter.GetDisplayText(modules(i))
groups(i) = navGroup