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

RibbonPageGroup.ImageIndex Property

Gets or sets the index of the image within the image collection that is displayed within the group when it’s in a collapsed state. This property is obsolete. Use the ImageOptions property instead.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v24.2.dll

NuGet Package: DevExpress.Win.Navigation

#Declaration

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

#Property Value

Type Default Description
Int32 -1

An integer that specifies the index of the image in the image collection.

#Remarks

A Ribbon group is automatically collapsed if there is not enough space to display its links. A collapsed group is represented by its caption which is specified by the RibbonPageGroup.Text property and an image. The following screenshot shows two collapsed groups (File and Edit):

RibbonPageGroup_Collapsed

To specify the image to display within a collapsed group use one of the following methods:

  • use the ImageOptions property to specify an image;
  • assign the image list or ImageCollection object to the RibbonControl.Images property and then assign the index of the required image in this list to the ImageOptions.ImageIndex property.

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