NavBarImage Enum

Contains possible styles for displaying images within groups’ captions.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v18.1.dll

Declaration

C#

public enum NavBarImage

VB.NET

Public Enum NavBarImage

Members

Name	Description
Default	A group’s caption displays a small image, if available. If no small image is available, the group displays a large image. If no large image is available, the group does not display any image.
Small	A group’s caption displays a small image, if available. If no small image is available, the group does not display any image.
Large	A group’s caption displays a large image, if available. If no large image is available, the group does not display any image.

Related API Members

The following properties accept/return NavBarImage values:

• NavBarGroup.GroupCaptionUseImage

Remarks

For each group you can specify small and large images to display within its caption. The NavBarGroup.GroupCaptionUseImage of the NavBarImage type specifies whether to display the small or large image in the group’s caption.

Large images can be set via the group’s NavElement.LargeImage and NavElement.LargeImageIndex properties. The latter property allows you to associate the group with a large image from the NavBarControl.LargeImages list. NavElement.LargeImage has a higher priority than NavElement.LargeImageIndex.

Similarly, small images can be set via the group’s NavElement.SmallImage and NavElement.SmallImageIndex properties. NavElement.SmallImageIndex specifies the index of a small image in the NavBarControl.SmallImages list. It has a lower priority than NavElement.SmallImage.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the NavBarImage enum.

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#L114

NavBarGroup group = navBarControl1.Groups.Add();
group.GroupCaptionUseImage = NavBarImage.Small;
group.Caption = "New Group";

VB.NET

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

Dim group As NavBarGroup = navBarControl1.Groups.Add()
group.GroupCaptionUseImage = NavBarImage.Small
group.Caption = "New Group"