Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

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

NuGet Packages: DevExpress.Utils, DevExpress.Wpf.Core

#Declaration

[DXCategory("Appearance")]
int ImageIndex { get; set; }

#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.

Tip

You can also assign an image by its name in the collection.

// The image collection is created and populated with images at design time.
barItem.ImageOptions.Image = imageCollection1["technology_32x32"]; 
// Assign an SVG image in the SvgCollection
// barItem.ImageOptions.SvgImage = svgCollection1["technology_32x32"];

Read the following help topic for more information: Access and Use DevExpress Icons in Code.

See Also