RibbonPageGroup.CaptionButtonVisible Property

Gets or sets whether the Caption Button is visible.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
[XtraSerializableProperty]
public DefaultBoolean CaptionButtonVisible { get; set; }

VB.NET

<XtraSerializableProperty>
<DefaultValue(DefaultBoolean.Default)>
Public Property CaptionButtonVisible As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	Specifies whether the Caption Button is visible. The DefaultBoolean.Default value equals DefaultBoolean.True if you handle the RibbonPageGroup.CaptionButtonClick or RibbonControl.PageGroupCaptionButtonClick event, and DefaultBoolean.False otherwise.

Available values:

Name	Description
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Remarks

A Ribbon Page Group can display a caption button. A user can click this button to perform an action, which you can implement with the RibbonPageGroup.CaptionButtonClick or RibbonControl.PageGroupCaptionButtonClick event.

By default, the caption button is hidden, unless you subscribe to the CaptionButtonClick or PageGroupCaptionButtonClick event.