IButtonProperties.ImageIndex Property

Gets or sets an IButtonProperties.Images collection member used as the current IButton object's glyph.

Namespace: DevExpress.XtraEditors.ButtonPanel

Assembly: DevExpress.Utils.v20.1.dll

Declaration

[DXCategory("Appearance")]
int ImageIndex { get; set; }
<DXCategory("Appearance")>
Property ImageIndex As Integer

Property Value

Type Description
Int32

An Int32 value that points to an IButtonProperties.Images collection member used as the current IButton object's glyph.

Remarks

Header Buttons and WindowsUI Custom Buttons can have text (see the IButtonProperties.Caption property) and a glyph, specified via the IButtonProperties.Image property. You can set whether only button text, or a glyph, or both of them should be displayed via the IButtonProperties.UseCaption and IButtonProperties.UseImage properties. If both text and glyph are shown, use the IButtonProperties.ImageLocation property to set their positions relative to each other.

You can also use the ImageIndex property to pick an image stored within the IButtonProperties.Images collection as a custom header button's glyph.

If the IButtonProperties.Glyphs property is not null, the ImageIndex and IButtonProperties.Image properties are ignored.

See the Header Buttons topic to learn more.

See Also