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

DockPanel.ImageIndex Property

Gets or sets the index of an image associated with the dock panel. This property is obsolete. Use the DockPanel.ImageOptions.ImageIndex property instead.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v24.2.dll

NuGet Package: DevExpress.Win.Navigation

#Declaration

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

#Property Value

Type Description
Int32

An integer value specifying the index of an image within the DockManager.Images list.

#Remarks

The ImageIndex property allows you to associate an image from the DockManager.Images list with the current dock panel. You can also use the DockPanel.ImageOptions.Image property to set the icon explicitly.

By default, images associated with panels are displayed within tabs when panels are joined into a tab container. Also, these images are painted within panel labels when the auto hide feature is enabled.

To allow images to be displayed within regular panels, set the DockingOptions.ShowCaptionImage property to true.

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