LayoutGroup.CaptionImageIndex Property

Gets or sets the index of an image in the LayoutControl.Images or LayoutView.Images collection that is displayed in the group or tab’s label.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v24.2.dll

Declaration

C#

[Browsable(false)]
[DefaultValue(-1)]
[DXCategory("Appearance")]
[EditorBrowsable(EditorBrowsableState.Never)]
[ImageList("ImageList")]
[XtraSerializableProperty]
public int CaptionImageIndex { get; set; }

VB.NET

<Browsable(False)>
<EditorBrowsable(EditorBrowsableState.Never)>
<DefaultValue(-1)>
<XtraSerializableProperty>
<ImageList("ImageList")>
<DXCategory("Appearance")>
Public Property CaptionImageIndex As Integer

Property Value

Type	Default	Description
Int32	-1	An integer value that specifies the zero-based index of an image in the LayoutControl.Images or LayoutView.Images collection.

Remarks

Use the CaptionImageOptions property to access the following options, which allow you to specify the icon in the layout group or tab’s label:

• SvgImage — specifies a vector image.
• ImageUri — specifies a universal resource identifier of an image in the DX Image Gallery.

• Image — specifies a raster image.

  This property is equivalent to the layout group’s CaptionImage property.

• ImageIndex — specifies an index of an image in the Images collection.

  The ImageIndex option is equivalent to the layout item’s CaptionImageIndex property. The Images collection is equivalent to the layout group’s ImageList property, and the LayoutControl‘s Images or the LayoutView‘s Images property depending on the owner control.

• Location — specifies the alignment of the image relative to the text. This property is not in effect in a tab.

  This property is equivalent to the layout group’s CaptionImageLocation property.

• Padding — specifies the amount of space between the icon and the label’s bounds. This property overrides the tabbed group’s CaptionImagePadding property, which specifies the padding for all tabs in the tabbed group.

  This property is equivalent to the layout group’s CaptionImagePadding property.

• AllowGlyphSkinning — specifies whether the icon is filled with the control’s foreground color. This property overrides the control’s AllowGlyphSkinning option. You can also use a layout item’s AllowGlyphSkinning option to enable this feature for an individual item.

  

  Tip

  We recommend using gray-scale icons from the DX Image Gallery for best visual results.

  This property is equivalent to the layout item’s AllowGlyphSkinning property.

• Visible — specifies whether the icon is visible.

  This property is equivalent to the layout group’s DevExpress.XtraLayout.LayoutGroup.CaptionImageVisible property.