Bar

BarMenuMerge Enum

Contains values specifying how bar items of a child MDI form are added to bars/Ribbon Controls of the parent MDI form during merge operations.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

public enum BarMenuMerge
Public Enum BarMenuMerge

Members

Name Description
Add

Specifies that the child form's bar item should be added to a bar/Ribbon Control or container item (e.g. menu) of a parent form.

When merging bars and container items, the position to insert the item is determined by the BarItem.MergeOrder properties of this item and of the items within the target bar/container item.

Replace

Indicates that the child form's bar item should replace the parent form's item that has the same BarItem.Caption, but only if the parent item's BarItem.MergeType property is also set to Replace.

If such an item is not found in the parent form's bar/RibbonControl, the child form's item will simply be added to the bar/Ribbon Control (similar to the BarMenuMerge.Add setting).

MergeItems

This setting is applied to container items (BarCustomContainerItem descendants).

It specifies that subitems of the child form's container item should be merged with subitems of a parent form's container item. Merging occurs for the parent form's container item, whose type and BarItem.Caption match the source item's ones and only if its BarItem.MergeType property is also set to MergeItems. Otherwise, the child form's container item will simply be added to the parent form's bar/Ribbon Control (similar to the BarMenuMerge.Add setting).

Remove

For a child form's bar item, indicates that the item must not be added to the parent form's bar/Ribbon Control during merging.

For a parent form's bar item, indicates that the item must be removed from the bar/Ribbon Control during merging.

Related API Members

The following properties accept/return BarMenuMerge values:

Remarks

In MDI applications, bars and Ribbon Controls support bar item merging. The merging feature allows bar items belonging to child and parent MDI forms to be merged. The manner in which the merge mechanism is invoked is specified by the BarManager.MdiMenuMergeStyle property.

During merging, bar item links of a child MDI form are added to a specific bar/Ribbon Control of the parent form. The BarMenuMerge type enumerates values specifying how links should be added to the parent form's bar/RibbonControl: whether they should be appended, replace existing items, etc. You can use the items' BarItem.MergeType property to access and control these settings.

See the MDI Merging and Ribbon Merging documents to learn more.

See Also