LayoutGroup.CaptionImageIndex Property
Gets the index of an image in an image collection which must be displayed within the group’s caption.
Namespace: DevExpress.XtraLayout
Assembly: DevExpress.XtraLayout.v19.1.dll
Declaration
[Browsable(false)]
[DefaultValue(-1)]
[XtraSerializableProperty]
[ImageList("ImageList")]
[DXCategory("Appearance")]
public int CaptionImageIndex { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| Int32 | -1 | A zero-based index of an image in an image collection, that is displayed within the group’s caption. |
Remarks
This property allows you to specify the image to display within the group’s caption by its index in an image collection. In a LayoutControl, the source of images is specified by the LayoutControl.Images property. In a LayoutView (Grid Control), the source of images is specified by the ColumnView.Images property.
You can display an image within a group’s caption either by assigning it directly to the LayoutGroup.CaptionImage property or by assigning an image list to the LayoutControl.Images collection, and then assigning the index of the required image in this list to the CaptionImageIndex property.
The CaptionImageIndex property has a higher priority. So, if an image is assigned via both the CaptionImageIndex and LayoutGroup.CaptionImage properties, the image specified by the 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.