RibbonControl.UseCaptionToIdentifyPagesOnMerging Property

Gets or sets whether the parent ribbon control should try to keep its selected page when merging with another child ribbon.

Namespace: DevExpress.Xpf.Ribbon

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

Declaration

public static bool UseCaptionToIdentifyPagesOnMerging { get; set; }
Public Shared Property UseCaptionToIdentifyPagesOnMerging As Boolean

Property Value

Type Description
Boolean

true, if the parent ribbon control should try to keep its selected page when merging with another child ribbon; otherwise, false.

Remarks

If your application has tabs with child ribbon controls and the main window contains the parent ribbon control that has to be merged with these child ribbons, the following scenario may cause confusion:

  • the currently selected ribbon page is a unique page that exists only within a child ribbon;
  • the RibbonControl.SelectedPageOnMerging property equals ParentSelectedPage;
  • an end-user navigates to another tab.

In this scenario, the previously selected page becomes unavailable, since it belongs to the child ribbon that has been unmerged. The RibbonControl.SelectedPageOnMerging property will force the parent ribbon to select its own page instead. If the newly selected tab contains the child ribbon with the same ribbon page, this can be confusing to end-users (the previously selected page still exists, but the selection jumps to another page). To prevent this misunderstanding, leave the static UseCaptionToIdentifyPagesOnMerging property at its default value (true).

See Also