BreadCrumbNode.Caption Property

Gets or sets this BreadCrumbNode‘s caption.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue("")]
[DXCategory("Appearance")]
public string Caption { get; set; }

VB.NET

<DXCategory("Appearance")>
<DefaultValue("")>
Public Property Caption As String

Property Value

Type	Default	Description
String	String.Empty	A String value that is this BreadCrumbNode‘s caption.

Remarks

The Caption property specifies the node caption, which can be displayed or hidden depending on the BreadCrumbNode.ShowCaption property.

Node captions are displayed at runtime when the BreadCrumbEdit control is in Select mode (see the RepositoryItemBreadCrumbEdit.BreadCrumbMode property). However, when the control is in Edit mode, to navigate through nodes, an end-user has to type these nodes’ values (the BreadCrumbNode.Value property). Thus, it’s not recommended to assign different values to the Caption and BreadCrumbNode.Value properties, which are equal by default.

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#

winforms-file-explorer-breadcrumb-folder-nav/CS/FileNavigator/Form1.cs#L55

//Add custom shortcuts to the 'Root' node
if (string.Equals(e.Node.Caption, "Root", StringComparison.Ordinal)) {
    InitBreadCrumbRootNode(e.Node);

VB.NET

winforms-file-explorer-breadcrumb-folder-nav/VB/Form1.vb#L57

'Add custom shortcuts to the 'Root' node
If String.Equals(e.Node.Caption, "Root", StringComparison.Ordinal) Then
    InitBreadCrumbRootNode(e.Node)