DockingOptions.ShowCaptionImage Property

Gets or sets whether an image associated with a dock panel is displayed within the panel’s caption.

Namespace : DevExpress.XtraBars.Docking

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

[DefaultValue(false)]
[XtraSerializableProperty]
public virtual bool ShowCaptionImage { get; set; }

<DefaultValue(False)>
<XtraSerializableProperty>
Public Overridable Property ShowCaptionImage As Boolean

Property Value

Type	Default	Description
Boolean	false

true if a dock panel’s image is displayed in the panel’s caption; otherwise false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to ShowCaptionImage
DockManager

.DockingOptions .ShowCaptionImage

Remarks

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 Working with Panel Containers is enabled.

If the ShowCaptionImage property is set to true , a dock panel’s image will also be displayed within the panel’s caption.

To assign an image to a dock panel, use the DockPanel.ImageOptions.ImageIndex property.