RibbonPageGroup.ShowCaptionButton Property

Gets or sets whether the Caption Button is visible. This is a dependency property.

Namespace: DevExpress.Xpf.Ribbon

Assembly: DevExpress.Xpf.Ribbon.v24.1.dll

NuGet Package: DevExpress.Wpf.Ribbon

Declaration

C#

public bool ShowCaptionButton { get; set; }

VB.NET

Public Property ShowCaptionButton As Boolean

Property Value

Type	Description
Boolean	true if the Caption Button is visible; otherwise, false.

Remarks

If the ShowCaptionButton property is set to true, the group displays a Caption Button:

By default, clicking this button has no effect. To implement a specific functionality, subscribe to the group’s RibbonPageGroup.CaptionButtonClick event or use the RibbonPageGroup.CaptionButtonCommand property.

You can display a tooltip when an end-user hovers over the Caption Button. This can be accomplished via the RibbonPageGroup.SuperTip property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ShowCaptionButton property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

wpf-spreadsheet-bind-spreadsheet-to-ms-sql-server-database/CS/WpfSpreadsheet_BindToDataSource/MainWindow.xaml#L1195

<dxr:RibbonPage x:Name="pageFile" Caption="{Binding ConverterParameter=Caption_PageFile, Converter={StaticResource stringIdConverter}, Mode=OneTime, Source={StaticResource stringIdConverter}}">
    <dxr:RibbonPageGroup x:Name="grpFileCommon" Caption="{Binding ConverterParameter=Caption_GroupCommon, Converter={StaticResource stringIdConverter}, Mode=OneTime, Source={StaticResource stringIdConverter}}" ShowCaptionButton="False">
        <dxr:RibbonPageGroup.ItemLinks>

wpf-spreadsheet-assign-custom-in-place-editors/CS/WpfSpreadsheet_CustomCellEditors/MainWindow.xaml#L1174

<dxr:RibbonPage x:Name="pageFile" Caption="{Binding ConverterParameter=Caption_PageFile, Converter={StaticResource stringIdConverter}, Mode=OneTime, Source={StaticResource stringIdConverter}}">
    <dxr:RibbonPageGroup x:Name="grpFileCommon" Caption="{Binding ConverterParameter=Caption_GroupCommon, Converter={StaticResource stringIdConverter}, Mode=OneTime, Source={StaticResource stringIdConverter}}" ShowCaptionButton="False">
        <dxr:RibbonPageGroup.ItemLinks>

wpf-spreadsheet-bind-a-worksheet-to-generic-list-or-bindinglist-data-source/CS/DataBindingToListExample/MainWindow.xaml#L547

<dxr:RibbonPage x:Name="pageFile" Caption="{Binding ConverterParameter=Caption_PageFile, Converter={StaticResource stringIdConverter}, Mode=OneTime, Source={StaticResource stringIdConverter}}">
    <dxr:RibbonPageGroup x:Name="grpFileCommon" Caption="{Binding ConverterParameter=Caption_GroupCommon, Converter={StaticResource stringIdConverter}, Mode=OneTime, Source={StaticResource stringIdConverter}}" ShowCaptionButton="False">
        <dxr:RibbonPageGroup.ItemLinks>

wpf-create-a-ribboncontrol/CS/RibbonControl_Ex/MainWindow.xaml#L113

<dxr:RibbonPageGroup Name="pgFile" Caption="File"
                     ShowCaptionButton="True"
                     CaptionButtonClick="groupFile_CaptionButtonClick"

dxrichedit-for-wpf-how-to-print-a-document-as-a-series-of-images/CS/SaveAsImage/MainWindow.xaml#L32

<dxr:RibbonPage Caption="{Binding Source={StaticResource stringIdConverter}, ConverterParameter=Caption_PageFile, Converter={StaticResource stringIdConverter}, Mode=OneTime}" Name="pageFile">
    <dxr:RibbonPageGroup Caption="{Binding Source={StaticResource stringIdConverter}, ConverterParameter=Caption_GroupCommon, Converter={StaticResource stringIdConverter}, Mode=OneTime}" Name="grpCommon" ShowCaptionButton="False">
        <dxb:BarButtonItemLink BarItemName="biFileNew" />