RibbonControl.MDIMergeStyle Property

Gets or sets if the RibbonControl can be merged.

Namespace: DevExpress.Xpf.Ribbon

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

NuGet Package: DevExpress.Wpf.Ribbon

Declaration

C#

public MDIMergeStyle MDIMergeStyle { get; set; }

VB.NET

Public Property MDIMergeStyle As MDIMergeStyle

Property Value

Type	Description
MDIMergeStyle	A MDIMergeStyle value specifying if the RibbonControl can be merged.

Available values:

Name	Description
Default	Identical to the MDIMergeStyle.Always value.
WhenChildActivated	Bars/ribbons are merged in the following cases: When you activate a maximized MDI child panel (MDI UI). When you select a tab (tabbed UI). Bars/ribbons are unmerged in the following cases: When you restore a maximized MDI child panel from the maximized to the normal state or deactivate it (MDI UI). When you deactivate a selected tab or select another tab (tabbed UI).
Always	The panel’s bar/ribbon is merged with the parent bar/ribbon in the following cases: When you maximize a DocumentGroup‘s MDI child panel (MDI UI). When you select the DocumentGroup‘s panel in the tab (tabbed UI). If your layout contains multiple DocumentGroups, the merging mechanism is invoked for all DocumentGroups simultaneously. In this case, all of them are merged to the parent at the same time. Bars/ribbons are unmerged in the following cases: When you restore an MDI child panel from the maximized state to the normal state (MDI UI). When you select another tab (Tabbed UI).
Never	Prevents all child tabbed and MDI panels from being merged.
WhenLoadedOrChildActivated	Similar to WhenChildActivated mode, but additionally merges MDI panels and tabs that are initially maximized (docked), but not yet selected (for example, on application start).

Remarks

The merging mechanism is invoked according to the DockLayoutManager.MDIMergeStyle and DocumentPanel.MDIMergeStyle properties.

You can prevent RibbonControls and RibbonStatusBarControls from being merged by setting the RibbonControl.MDIMergeStyle and/or RibbonStatusBarControl.MDIMergeStyle property to MDIMergeStyle.Never. If these properties are set to other values, merging is enabled for these objects.

See MDI Ribbon Merging to learn more.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the MDIMergeStyle 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-docklayoutmanager-merge-ribbon-controls/CS/WpfApplication1/MainWindow.xaml#L8

<DockPanel>
    <dxr:RibbonControl x:Name="ParentRibbonControl" DockPanel.Dock="Top" Height="auto" MDIMergeStyle="Always" SelectedPageOnMerging="ParentSelectedPage">
        <dxr:RibbonDefaultPageCategory>