NavBarGroup.GroupCaptionUseImage Property

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

Assembly : DevExpress.XtraNavBar.v25.2.dll

Declaration

C#
VB.NET

csharp

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

<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 using the group’s LargeImage and SmallImage options accessible in NavElement.ImageOptions
add large or small images to the respective image lists, assign these image lists to NavBarControl.LargeImages and NavBarControl.SmallImages properties, and specify image indexes using LargeImageIndex and SmallImageIndex options accessible in NavElement.ImageOptions.

If an image is assigned to the LargeImage/SmallImage property, the LargeImageIndex/SmallImageIndex setting is ignored.

If the GroupCaptionUseImage property is set to NavBarImage.Default, small images (if assigned) have a higher priority than large images. If small images are not assigned, 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.