NavBarItemLink.Caption Property

Gets the link’s caption.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v24.1.dll

NuGet Packages: DevExpress.Win, DevExpress.Win.Navigation

Declaration

C#

[SearchColumn]
public string Caption { get; }

VB.NET

<SearchColumn>
Public ReadOnly Property Caption As String

Property Value

Type	Description
String	A string value representing the link’s caption.

Remarks

This property reads the NavElement.Caption property of the corresponding NavBarItem object to return its value. This object is obtained via the NavBarItemLink.Item property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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#

create-navbar-control-in-code/CS/CreateNavBar/Form1.cs#L97

void navBar_SelectedLinkChanged(object sender, DevExpress.XtraNavBar.ViewInfo.NavBarSelectedLinkChangedEventArgs e) {
    string s = string.Format("'{0}' selected", e.Link.Caption);
    listBoxControl1.Items.Add(s);

VB.NET

create-navbar-control-in-code/VB/CreateNavBar/Form1.vb#L85

Private Sub navBar_SelectedLinkChanged(ByVal sender As Object, ByVal e As ViewInfo.NavBarSelectedLinkChangedEventArgs)
    Dim s As String = String.Format("'{0}' selected", e.Link.Caption)
    listBoxControl1.Items.Add(s)