XtraMdiTabPage.ImageIndex Property

Gets or sets the index of the image displayed within the tab page’s header.

Namespace: DevExpress.XtraTabbedMdi

Assembly: DevExpress.XtraBars.v23.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
Int32	-1	A zero-based integer value specifying the index of an image within the XtraTabbedMdiManager.Images list.

Remarks

Tab pages can display images in headers.

The ImageOptions property provides access to a set of options that specify the raster or vector image displayed in the header.

The Image property and the Image property accessible through the XtraMdiTabPage.ImageOptions property are equivalent and allow you to specify a raster image for the tab header.

The ImageIndex property and the ImageIndex property accessible through the XtraMdiTabPage.ImageOptions property are equivalent and allow you to specify an index of an image from the XtraTabbedMdiManager.Images collection.

The Image property has priority over the ImageIndex property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ImageIndex property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-tabbed-mdi-manager-display-custom-header-button/CS/WindowsFormsApplication32/Form1.cs#L32

    XtraTabbedMdiManager tabbedMdi = (XtraTabbedMdiManager)sender;
    e.Page.ImageIndex = tabbedMdi.Pages.Count - 1;
}

VB.NET

winforms-tabbed-mdi-manager-display-custom-header-button/VB/WindowsFormsApplication32/Form1.vb#L29

    Dim tabbedMdi As XtraTabbedMdiManager = CType(sender, XtraTabbedMdiManager)
    e.Page.ImageIndex = tabbedMdi.Pages.Count - 1
End Sub