LayoutControlItem.ImageIndex Property

Gets or sets the index of the icon displayed in the item’s label.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
Int32	-1	An integer value that specifies the index of an icon in an image collection.

Remarks

Use the ImageOptions property to access the following options, which allow you to specify the icon in the layout item’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 item’s Image property.

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

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

• Alignment — specifies the alignment of the image in the label.

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

• ImageToTextDistance — specifies the distance between the label’s text and icon.

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

• AllowGlyphSkinning — specifies whether the icon is filled with the label’s foreground color. This property overrides the parent group’s AllowGlyphSkinning and the owner control’s AllowGlyphSkinning options.

  

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

  Tip

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