RibbonControl.ShowDisplayOptionsMenuButton Property
Gets or sets whether the button allowing an end-user to switch between the regular, minimized and full-screen ribbon modes is displayed in the form title bar. This property is in effect for the RibbonControl embedded into the RibbonForm, and displayed using the Office2013 style.
Namespace: DevExpress.XtraBars.Ribbon
Assembly: DevExpress.XtraBars.v23.2.dll
NuGet Package: DevExpress.Win.Navigation
Declaration
[DefaultValue(DefaultBoolean.Default)]
[DXCategory("Behavior")]
[XtraSerializableProperty]
public DefaultBoolean ShowDisplayOptionsMenuButton { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| DefaultBoolean | Default | True or Default, if the button is displayed; otherwise, False. |
Available values:
| Name | Description | Return Value |
|---|---|---|
| True | The value is true. |
|
| False | The value is false. |
|
| Default | The value is specified by a global option or a higher-level object. |
|
Remarks
The RibbonControl in the Office2013 style, when embedded into the RibbonForm, can be displayed in one of three modes:
- Show Tabs and Commands—the ribbon is displayed in the regular, expanded state. Page tabs and commands are visible all the time;
- Show Tabs—the ribbon is minimized, hiding the page contents. In this mode, only page headers are visible, and an end-user can click on a page header to display the page onscreen. This mode cannot be activated if the RibbonControl.AllowMinimizeRibbon setting is disabled.
- Auto-hide Ribbon—the ribbon is automatically hidden on an outside click. The application window is forcibly maximized in this mode. An end-user can click at the top of the application to show the ribbon.
The ShowDisplayOptionsMenuButton property specifies whether the button that allows an end-user to switch these modes is displayed in the form title bar. A click on this button invokes the dropdown window that allows an end-user to select the required mode. See the figure below.
By default, the dropdown window width is set to a value that allows all menu items to be displayed in their entirety. The RibbonControl.OptionsMenuMinWidth property allows you to set the dropdown window width to any custom value.
To switch between the Show Tabs and Show Tabs and Commands mode in code, use the RibbonControl.Minimized property.
To switch between the regular and full-screen modes in code, use the RibbonControl.FullScreen property. Changing the RibbonControl.FullScreen property at run time raises the RibbonControl.ScreenModeChanged event.