Skip to main content

LayoutGroup.CaptionImage Property

Specifies the image to display within the group’s caption area.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

[Browsable(false)]
[DefaultValue(null)]
[DXCategory("Appearance")]
[EditorBrowsable(EditorBrowsableState.Never)]
public Image CaptionImage { get; set; }

Property Value

Type Default Description
Image null

A Image object that specifies the group’s caption image.

Remarks

Use the CaptionImage property to specify the image to display in the group’s caption.

If images are stored in a list (ImageList or ImageCollection) use the LayoutControl.Images property to assign this list to the LayoutControl. Then use the LayoutGroup.CaptionImageIndex property to assign a specific image from this list to the group.

The LayoutGroup.CaptionImageIndex property has a higher priority. So if an image is assigned via both the CaptionImage and LayoutGroup.CaptionImageIndex properties the image specified by the LayoutGroup.CaptionImageIndex property will be used.

The visibility and position of the group’s image are specified by the LayoutGroup.CaptionImageVisible and LayoutGroup.CaptionImageLocation properties respectively.

See Also