Back to Devexpress

LayoutGroup.CaptionImageIndex Property

windowsforms-devexpress-dot-xtralayout-dot-layoutgroup-d84ad9d3.md

latest3.9 KB
Original Source

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.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[Browsable(false)]
[DefaultValue(-1)]
[DXCategory("Appearance")]
[EditorBrowsable(EditorBrowsableState.Never)]
[ImageList("ImageList")]
[XtraSerializableProperty]
public int CaptionImageIndex { get; set; }
vb
<Browsable(False)>
<EditorBrowsable(EditorBrowsableState.Never)>
<DefaultValue(-1)>
<XtraSerializableProperty>
<ImageList("ImageList")>
<DXCategory("Appearance")>
Public Property CaptionImageIndex As Integer

Property Value

TypeDefaultDescription
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:

SvgImageSpecifies a vector image.ImageUriSpecifies a universal resource identifier of an image in the DX Image Gallery.ImageSpecifies a raster image.ImageIndexSpecifies an index of an image in the Images collection.LocationSpecifies the alignment of the image relative to the text. This property is not in effect in a tab.PaddingSpecifies 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.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.

VisibleSpecifies whether the icon is visible. See Also

CaptionImageOptions

Images

LayoutGroup Class

LayoutGroup Members

DevExpress.XtraLayout Namespace