NavBarGroup.GetImage() Method

Returns the image to display within the group caption.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v24.2.dll

NuGet Package: DevExpress.Win

Declaration

C#

public virtual Image GetImage()

VB.NET

Public Overridable Function GetImage As Image

Returns

Type	Description
Image	A Image object specifying the image to display within the group caption. null if no image is assigned to the group.

Remarks

This function returns the small or large image assigned to the group, dependent upon the NavBarGroup.GroupCaptionUseImage property. To specify large images for a group, use the LargeImage or LargeImageIndex option accessible in NavElement.ImageOptions. Small images can be assigned using the SmallImage or SmallImageIndex option accessible in NavElement.ImageOptions.

For more information, see the NavBarGroup.GroupCaptionUseImage topic.

SideBar Views do not allow images to be displayed in group captions.