NavBarGroup.GroupCaptionUseImage Property

Gets or sets whether a big or small image is displayed within the group caption.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v19.1.dll

Declaration

C#

[DefaultValue(NavBarImage.Default)]
[XtraSerializableProperty]
public virtual NavBarImage GroupCaptionUseImage { get; set; }

VB.NET

<DefaultValue(NavBarImage.Default)>
<XtraSerializableProperty>
Public Overridable Property GroupCaptionUseImage As NavBarImage

Property Value

Type	Default	Description
NavBarImage	**Default**	A NavBarImage value representing the fixed image size to use within the group caption.

Available values:

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.

Remarks

The GroupCaptionUseImage property controls whether small or large images are displayed within the group caption.

Each NavBar group can display either a small or large image within its caption. You can specify images for the group caption in the following ways:

• assign large or small images explicitly via the group’s NavElement.LargeImage and NavElement.SmallImage properties
• add large or small images to the respective image lists, assign these image lists to the NavBarControl.LargeImages and NavBarControl.SmallImages properties and then specify the indexes of the images to use via the group’s NavElement.LargeImageIndex and NavElement.SmallImageIndex properties.

If an image is assigned to the NavElement.LargeImage property, the NavElement.LargeImageIndex setting is ignored. Similarly, if the NavElement.SmallImage property is set it overrides the image referred to by the NavElement.SmallImageIndex property.

If the GroupCaptionUseImage property is set to NavBarImage.Default then small images if assigned (NavElement.SmallImage and NavElement.SmallImageIndex)have a higher priority than large images (NavElement.LargeImage or NavElement.LargeImageIndex). If small images are not set, the group caption will display a large image, if available.

For groups to explicitly use small or large images, set the GroupCaptionUseImage property to NavBarImage.Small or NavBarImage.Large.

The NavBarGroup.GetImage method returns the image to be displayed within the group caption which depends on the settings specified.

Related GitHub Examples

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