BinaryRibbonBarPanel

Creates a ribbon with no tabs, application menu or quick access toolbar.

Gets the command that scrolls a ribbon too narrow for its groups back to the first group. Raise it from a control inside the ribbon, or with the ribbon as its CommandTarget.

Gets the command that scrolls a ribbon too narrow for its groups on to the last group.

Gets or sets the application button at the start of the tab row and the menu it opens.

Gets the colour of the contextual tab set the selected tab belongs to.

Gets or sets whether only the tab row is shown, with a tab's commands dropped over the document when it is clicked.

Kept in step with DisplayState being BinaryRibbonDisplayState.ShowTabsOnly; prefer DisplayState, which also offers auto-hide. A double-click on a tab toggles it.

Gets or sets whether the user is offered the choice between the classic and the simplified ribbon.

When false, neither the ribbon's right-click menu nor the window's ribbon display options offer the two layouts; RibbonLayout still works from code.

Gets the command that closes the commands a tabs-only ribbon has dropped over the document, by setting IsExpanded to false.

Gets or sets the contextual tab set on show at the end of the tab row – the tabs that belong to what the user has selected, under a coloured title.

Set it when the user selects what the tabs act on, and clear it when they move away; clearing it while one of its tabs is selected selects the first tab.

Gets the contextual tab sets this ribbon knows about, whether or not one is on show.

Adding a set here connects it to the ribbon but does not show it; show one by assigning it to ContextualTabSet.

Gets the tabs on show, ordinary then contextual, leaving out any that are hidden.

Gets or sets how much of the ribbon is on screen: the tabs and their commands, the tabs alone, or neither.

• BinaryRibbonDisplayState.ShowTabsAndCommands — The whole ribbon.
• BinaryRibbonDisplayState.ShowTabsOnly — Only the tab row; clicking a tab drops its commands over the document until a command is used or the user clicks away. Sets CanMinimize.
• BinaryRibbonDisplayState.AutoHide — Neither tabs nor commands; the title and the quick access toolbar stay. Clears IsRibbonControlVisible.

The user changes it with Ctrl+F1 (IsDisplayStateShortcutEnabled), a double-click on a tab, the ribbon's right-click menu and the ribbon display options button of a BinaryRibbonWindow. The ribbon saves nothing itself: store the value with the user's other settings to keep it between runs.

<bm:BinaryRibbonBarPanel DisplayState="ShowTabsOnly" IsDisplayStateShortcutEnabled="True" />

Gets or sets whether Ctrl+F1, pressed anywhere in the ribbon's window, calls ToggleDisplayState.

Set it to false when the application gives Ctrl+F1 a meaning of its own. The key is heard on the window, so it works while the focus is in the document.

Gets or sets whether a tabs-only ribbon has dropped the selected tab's commands over the document.

Used while DisplayState is BinaryRibbonDisplayState.ShowTabsOnly: clicking a tab sets it; a command, a click elsewhere or CollapseRibbonBarCommand clears it.

Gets or sets a flag the ribbon clears whenever it closes its drop-downs.

Setting it opens nothing; to open the application menu, set BinaryRibbonApplicationMenu.IsOpen.

Gets whether the ribbon is too narrow to show anything but its title, with its tabs, commands and quick access toolbar hidden.

Gets or sets whether right-clicking the ribbon offers its own menu: add to or remove from the quick access toolbar, show the toolbar above or below the ribbon, simplified ribbon, and collapse the ribbon.

Set it to false to give the ribbon a context menu of your own. The quick access toolbar entries are offered only when the ribbon has a QuickAccessToolBar, and the simplified ribbon entry only while CanUserChangeRibbonLayout is on.

Gets or sets whether the tab row and the commands are on show; the title and the quick access toolbar stay either way.

BinaryRibbonDisplayState.AutoHide clears it and the other display states set it.

Gets whether the ribbon is laid out for touch: small commands on taller rows, with more space between the columns, as in Office's touch mode.

The density belongs to the application, not to one ribbon: set BinarySkinManager.Density and every ribbon on screen lays its groups out again, with rows of 32 logical pixels instead of 24. An application offering Office's Touch/Mouse Mode command sets it from there.

// The Touch/Mouse Mode command on the quick access toolbar.
private void OnTouchModeClick(object sender, RoutedEventArgs e)
{
    BinarySkinManager.Density = ribbon.IsTouchMode ? BinarySkinDensity.Standard : BinarySkinDensity.Touch;
}

Gets the application menu, the quick access toolbar and every tab, contextual tabs included.

Gets or sets the quick access toolbar: the small commands kept on show whichever tab is selected.

Gets or sets whether the ribbon lays its commands out in the classic three rows or on the single line of the simplified ribbon.

In the simplified layout each group is one line of small pictures with captions and has no title; as the window narrows the captions go, and then the group folds into a button whose drop-down shows the commands in the usual rows. Galleries always fold.

Independent of DisplayState: a simplified ribbon can still show only its tabs. The user switches layouts from the right-click menu and the window's ribbon display options, unless CanUserChangeRibbonLayout is off. The ribbon saves nothing itself; store the value with the user's settings to keep it between runs.

Gets the groups of the selected tab – the groups the ribbon is showing.

Gets or sets the position of the selected tab.

Each change raises SelectedTabIndexChanged. A position past the last tab, or -1, selects no tab and shows no groups.

Gets or sets the tab whose groups are on show.

Setting it sets SelectedTabIndex; null, or a tab that is not on this ribbon, sets it to -1 and selects no tab. On a tabs-only ribbon, setting the tab already selected opens or closes its dropped-down commands, as clicking it does.

Gets the ribbon's tabs, in the order they appear. This is the ribbon's content in XAML.

Contextual tabs are not added here but through ContextualTabSet. Add the tabs before the ribbon's template is applied – in XAML, or before the window is shown.

Gets or sets the caption shown in bold in the title row, beside the quick access toolbar.

A BinaryRibbonWindow does not draw its own Window.Title; bind this to it to show it. A long caption ends in an ellipsis.

Gets or sets whether the quick access toolbar sits above the tabs or below the ribbon.

The user can move it from the right-click menu. A change is passed on to the toolbar's BinaryRibbonQuickAccessToolBar.ToolBarPlacementLocation.

Puts a shortcut to a ribbon command on the quick access toolbar, as the user's "Add to Quick Access Toolbar" does.

The command stays where it is: the toolbar gets a small BinaryRibbonButton with the command's small picture (or, failing that, its large one) and its tool tip, whose click raises the command's own click and runs its ICommand. To keep the toolbar between runs, give the command a SetCommandId and use GetQuickAccessToolBarState.

ribbon.AddToQuickAccessToolBar(printButton);

Arranges the ribbon, and sizes the contextual tab set's title to the width of its tabs.

The space the ribbon used.

Gets the name a ribbon command is saved under in GetQuickAccessToolBarState.

The name, or null when it has none or element is null.

Gets the largest size a command is drawn at.

The size; BinaryRibbonControlSize.Large unless set.

Gets the smallest size a command shrinks to as its group gives way.

The size; BinaryRibbonControlSize.Minimized unless set.

Gets the ribbon command a quick access toolbar shortcut stands for.

The command on the ribbon, or null when the item is not a shortcut (or element is null).

Describes the quick access toolbar – where it sits and which commands the user put on it – as one string to save with the user's settings.

The string to hand back to SetQuickAccessToolBarState on the next run, or an empty string when the ribbon has no QuickAccessToolBar.

Only shortcuts standing for a command with a SetCommandId are written down; items put on the toolbar directly in XAML are part of the application and are not.

// On closing - QuickAccess is a user setting of type string:
Properties.Settings.Default.QuickAccess = ribbon.GetQuickAccessToolBarState();
Properties.Settings.Default.Save();

// On the next start, once the window is loaded:
ribbon.SetQuickAccessToolBarState(Properties.Settings.Default.QuickAccess);

Gets the sizes a command takes, step by step, as its group gives way.

The sizes, or null (the default) when the group decides.

Gets the size a ribbon command is drawn at.

The size; BinaryRibbonControlSize.Large unless set.

Finds a tab's position among the tabs on show.

Its zero-based position in CurrentlyVisibleTabItems, or -1 when it is null, hidden or not on this ribbon.

Takes the template's group panels, drop-down and tab container, and puts the tabs into the tab row.

Called when ContextualTabSet changes; the base implementation swaps the tabs in the tab row.

Called when ContextualTabSets changes; the base implementation connects each added set to this ribbon and disconnects each removed one.

Called when IsExpanded changes; the base implementation opens or closes the drop-down.

Clears IsMenuOpen when the keyboard focus leaves the ribbon.

Closes the dropped-down commands of a tabs-only ribbon when the user clicks away from them.

Called when the dropped-down commands of a tabs-only ribbon close. The base implementation clears IsExpanded and releases the mouse; call it when overriding.

Called when a tabs-only ribbon drops its commands over the document. The base implementation sizes the groups to the drop-down and captures the mouse; call it when overriding.

Releases the mouse when the ribbon's own background is clicked.

Opens the ribbon's right-click menu when the right button is released, unless IsRibbonContextMenuEnabled is off.

On the button coming up rather than going down, so that the control under the pointer is not left looking pressed.

Called when SelectedGroups changes, after another tab is selected. The base implementation does nothing.

Called when SelectedTabIndex changes; the base implementation updates BackgroundColor.

Called when Tabs changes; the base implementation connects each added tab to this ribbon and disconnects each removed one.

Starts following the width of the ribbon's new parent, so that the groups give way or come back as it is resized.

Takes a command off the quick access toolbar.

Sets the name a ribbon command is saved under in GetQuickAccessToolBarState.

Called when the groups are scrolled to their start or end, or back to fitting the full width. The base implementation does nothing.

Sets the largest size a command is drawn at, even with room to spare.

Sets the smallest size a command shrinks to as its group gives way.

Sets the ribbon command a quick access toolbar shortcut stands for.

AddToQuickAccessToolBar sets it; set it yourself only on a shortcut you add to the toolbar by hand, so that the ribbon treats it as that command's shortcut.

Puts the quick access toolbar back as GetQuickAccessToolBarState described it.

The toolbar's position is restored and a shortcut added for each named command, beside what is already on the toolbar. A name no longer on the ribbon is skipped, and an unreadable position is ignored, so a saved setting that has outlived a command never stops the rest being restored.

Sets the sizes a command takes, step by step, as its group gives way.

When set, SetMinSize and SetMaxSize are not applied, and the group folds into a single button after as many steps as its longest list.

Sets the size a ribbon command is drawn at.

A group sets this on its commands whenever it is resized; for a command in a group use SetMaxSize, SetMinSize or SetResizableSize.

Switches between showing the commands and showing only the tabs, as Ctrl+F1 and a double-click on a tab do.

From BinaryRibbonDisplayState.ShowTabsAndCommands it goes to BinaryRibbonDisplayState.ShowTabsOnly; from either other state it brings the whole ribbon back, so it is always the way back to a ribbon that is out of sight.

Switches RibbonLayout between the classic and the simplified ribbon.

Finds the tab at a position among the tabs on show.

The tab, or null when the position is negative or past the last tab.

Occurs when another tab is selected, by the user or through SelectedTabIndex.

A bubbling routed event; read SelectedTabItem for the new tab.

Identifies the ApplicationMenu dependency property.

Identifies the BackgroundColor dependency property.

Identifies the CanMinimize dependency property.

Identifies the CanUserChangeRibbonLayout dependency property.

Identifies the CommandId attached property.

A command without one can still be put on the quick access toolbar; it is just not remembered between runs, because there is nothing to write down. Only commands directly in a group on one of the ordinary Tabs are found again by SetQuickAccessToolBarState.

<bm:BinaryRibbonButton Content="Send" LargeImage="Images/Send32.png" bm:BinaryRibbonBarPanel.CommandId="Invoice.Send" />

Identifies the ContextualTabSet dependency property.

Identifies the DisplayState dependency property.

Identifies the IsDisplayStateShortcutEnabled dependency property.

Identifies the IsExpanded dependency property.

Identifies the IsMenuOpen dependency property.

Identifies the IsMinimized dependency property.

Identifies the IsRibbonContextMenuEnabled dependency property.

Identifies the IsRibbonControlVisible dependency property.

Identifies the MaxSize attached property. The default is BinaryRibbonControlSize.Large.

Identifies the MinSize attached property. The default is BinaryRibbonControlSize.Minimized.

Identifies the QuickAccessSource attached property.

Identifies the QuickAccessToolBar dependency property.

Identifies the ResizableSize attached property.

Identifies the RibbonLayout dependency property.

Identifies the SelectedGroups dependency property.

Identifies the SelectedTabIndexChanged routed event.

Identifies the SelectedTabIndex dependency property.

Identifies the Size attached property. The default is BinaryRibbonControlSize.Large.

Identifies the TitleText dependency property.

Identifies the ToolbarPlacementLocation dependency property.