Skip to main content
Bar

BarLargeButtonItem.ShowCaptionOnBar Property

Gets or sets a value specifying whether captions are displayed within links residing on toolbars.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

[DefaultValue(true)]
public virtual bool ShowCaptionOnBar { get; set; }

Property Value

Type Default Description
Boolean true

true if captions are displayed in links residing on toolbars; otherwise false.

Remarks

The BarItem.PaintStyle property is used in combination with the ShowCaptionOnBar property. If the ShowCaptionOnBar property value is true, caption visibility is specified in accordance with the BarItem.PaintStyle property. If the ShowCaptionOnBar property is set to false, the caption is only painted when the BarItem.PaintStyle property value is BarItemPaintStyle.Caption.

The ShowCaptionOnBar property is ignored if only a small image is assigned to a link. In this case, the caption visibility can be controlled with the inherited BarItem.PaintStyle property. If this property is set to Standard, only a small image (without a caption) is displayed. To display the image along with the caption, set the BarItem.PaintStyle property to CaptionGlyph.

See Also