Skip to main content

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.v24.2.dll

Declaration

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

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.ImageIndex property.

See Also