RibbonControl.MDIMergeStyle Property

Gets or sets if the RibbonControl can be merged.

Namespace: DevExpress.Xpf.Ribbon

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

Declaration

public MDIMergeStyle MDIMergeStyle { get; set; }

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

The merging mechanism is invoked when a maximized MDI child panel is activated. In the case of a tabbed UI, the merging mechanism is invoked when a selected tab is activated.

The unmerge mechanism is invoked when a maximized MDI child panel is restored from the maximized state to the normal state, or when it is deactivated. In the case of a tabbed UI, the unmerge mechanism is invoked when a selected tab is deselected or deactivated.

Always

The merging mechanism is invoked when an MDI child panel is maximized in a DocumentGroup. In the case of a tabbed UI, it is invoked when a tab is selected in a DocumentGroup. If there are multiple DocumentGroups, the merging mechanism is invoked for all DocumentGroups simultaneously, thus all of them are merged to the parent at the same time.

The unmerge mechanism is invoked when an MDI child panel is restored from the maximized state to the normal state, or in case of the Tabbed UI, when another tab is selected.

Never

Prevents all child tabbed and MDI panels from being merged.

WhenLoadedOrChildActivated

Similar to the WhenChildActivated mode. Additionally, merges those MDI panels and tabs that are initially maximized (docked), but not yet selected (e.g., 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.

See Also