XtraMdiTabPage.Image Property

Use the ImageOptions property to specify the image displayed within the tab page’s header.

Namespace: DevExpress.XtraTabbedMdi

Assembly: DevExpress.XtraBars.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
public virtual Image Image { get; set; }

VB.NET

<Browsable(False)>
<EditorBrowsable(EditorBrowsableState.Never)>
Public Overridable Property Image As Image

Property Value

Type	Description
Image	A Image object which represents the image displayed within the tab page’s header.

Remarks

Tab pages can display images in headers.

The ImageOptions property provides access to image-related settings. Use the following properties to display the raster or vector image in the header:

SvgImage

Specifies a vector image (SVG) for the tab header.

Image

Specifies a raster image for the tab header.

ImageIndex

Specifies the 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 Image 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/MyTabbedMdiManager/MyTabbedMdiManager.cs#L61

{
    if ( page.Image != null )
        return page.Image;

VB.NET

winforms-tabbed-mdi-manager-display-custom-header-button/VB/WindowsFormsApplication32/MyTabbedMdiManager/MyTabbedMdiManager.vb#L51

Protected Function GetMdiTabPageImage(ByVal page As XtraMdiTabPage) As Image
    If page.Image IsNot Nothing Then Return page.Image
    Return ImageCollection.GetImageListImage(page.TabControl.Images, page.ImageIndex)