RibbonPageGroup.CaptionButtonVisible Property

Gets or sets whether the Caption Button is visible.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v24.2.dll

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	Return Value
True	The value is true.	0
False	The value is false.	1
Default	The value is specified by a global option or a higher-level object.	2

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.