Ribbon Class

[TemplatePart(Name = "PART_ApplicationButtonPresenter", Type = typeof(ContentPresenter))]
[TemplatePart(Name = "PART_ContextualTabGroupItemsControl", Type = typeof(RibbonContextualTabGroupItemsControl))]
[TemplatePart(Name = "PART_FooterPresenter", Type = typeof(ContentPresenter))]
[TemplatePart(Name = "PART_QatAbovePresenter", Type = typeof(ContentPresenter))]
[TemplatePart(Name = "PART_QatBelowPresenter", Type = typeof(ContentPresenter))]
[TemplatePart(Name = "PART_ItemsPresenter", Type = typeof(ItemsPresenter))]
[TemplatePart(Name = "PART_TabHeaderItemsControl", Type = typeof(RibbonTabHeaderItemsControl))]
[TemplatePart(Name = "PART_TabRowToolBarPresenter", Type = typeof(ContentPresenter))]
public class Ribbon : Selector, IRootBarControl

public Ribbon()

public ICommand AddToQuickAccessToolBarCommand { get; }

Property Value

ICommand:

The ICommand used to add an element passed in the command parameter to the quick-access toolbar.

public bool AllowLabelsOnQuickAccessToolBar { get; set; }

Property Value

bool:

true if the quick-access toolbar allows labels when it is below the ribbon; otherwise, false. The default value is false.

public object ApplicationButtonContent { get; set; }

Property Value

object:

The application button, which can either be an application button view model that uses ItemContainerTemplateSelector for its UI, or a RibbonApplicationButton control instance.

public Style ApplicationButtonStyle { get; set; }

Property Value

Style:

The Style that targets RibbonApplicationButton.

public object BackstageContent { get; set; }

Property Value

object:

The backstage, which can either be a backstage view model that uses ItemContainerTemplateSelector for its UI, or a RibbonBackstage control instance.

public Style BackstageStyle { get; set; }

Property Value

Style:

The Style that targets RibbonBackstage.

public bool CanChangeLayoutMode { get; set; }

Property Value

bool:

true if the end user can change the layout mode; otherwise, false. The default value is true.

public ICommand ClearFooterCommand { get; set; }

Property Value

ICommand:

An ICommand. The default value is a command that sets the FooterContent property to null.

public ICloneService CloneService { get; set; }

Property Value

ICloneService:

The ICloneService to be used. When not defined, a default BarsCloneService is used.

public Size CollapseThresholdSize { get; set; }

Property Value

Size:

The threshold System.Windows.Size that triggers a ribbon collapse if the ribbon is sized smaller than the threshold. The default value is 270, 170.

See Also

• IsCollapsed
• IsCollapsible

public IList ContextualTabGroups { get; set; }

Property Value

IList:

The collection of optional contextual tab groups within the ribbon. The items can either be contextual tab group view models that use ItemContainerTemplateSelector for their UI, or RibbonContextualTabGroup control instances.

public CornerRadius CornerRadius { get; set; }

Property Value

CornerRadius:

The corner radius of the control's border.

public object FooterContent { get; set; }

Property Value

object:

The optional footer content, which can either be a footer view model that uses ItemContainerTemplateSelector for its UI, or a RibbonFooterControl control instance.

public bool IsAnimationEnabled { get; set; }

Property Value

bool:

true if animation is enabled; otherwise, false. The default value is true.

public bool IsApplicationButtonVisible { get; set; }

Property Value

bool:

true if the application button is visible; otherwise, false. The default value is true.

public bool IsCollapsed { get; set; }

Property Value

bool:

true if the ribbon is currently collapsed; otherwise, false. The default value is false.

Remarks

The ribbon will collapse when it is forced to be smaller than a certain minimum size as specified by its IsCollapsible and CollapseThresholdSize properties.

See Also

• CollapseThresholdSize
• IsCollapsible

public bool IsCollapsible { get; set; }

Property Value

bool:

true if the ribbon auto-collapsed when it becomes smaller than the threshold; otherwise, false. The default value is true.

See Also

• CollapseThresholdSize
• IsCollapsed

public bool IsContentContainerVisible { get; }

Property Value

bool:

true if the content container is visible; otherwise, false.

public bool IsFooterSeparatorVisible { get; }

Property Value

bool:

true if the footer separator is visible; otherwise, false.

public bool IsFooterVisible { get; }

Property Value

bool:

true if the footer is visible; otherwise, false.

public bool IsMinimizable { get; set; }

Property Value

bool:

true if the ribbon is minimizable; otherwise, false. The default value is true.

public bool IsMinimized { get; set; }

Property Value

bool:

true if the ribbon is currently minimized; otherwise, false. The default value is false.

public bool IsMinimizedPopupOpen { get; }

Property Value

bool:

true if the ribbon's minimized popup is open; otherwise, false.

public bool IsOptionsButtonVisible { get; set; }

Property Value

bool:

true if the options button is visible; otherwise, false. The default value is true.

public bool IsQuickAccessToolBarSeparatorVisible { get; }

Property Value

bool:

true if the quick-access toolbar's separator is visible; otherwise, false.

public ItemContainerTemplateSelector ItemContainerTemplateSelector { get; set; }

Property Value

ItemContainerTemplateSelector:

The ItemContainerTemplateSelector that creates UI controls for bar control view models.

public RibbonLayoutMode LayoutMode { get; set; }

Property Value

RibbonLayoutMode:

A RibbonLayoutMode that indicates the current layout mode. The default value is Classic.

[Localizability(LocalizationCategory.Label)]
public string OptionsButtonKeyTipText { get; set; }

Property Value

string:

The key tip text for the options button.

[Localizability(LocalizationCategory.Label)]
public string OptionsButtonLabel { get; set; }

Property Value

string:

The text label for the options button.

public object OptionsButtonToolTip { get; set; }

Property Value

object:

The tooltip for the options button.

public object QuickAccessToolBarContent { get; set; }

Property Value

object:

The quick-access toolbar, which can either be a quick-access toolbar view model that uses ItemContainerTemplateSelector for its UI, or a RibbonQuickAccessToolBar control instance.

public RibbonQuickAccessToolBarLocation QuickAccessToolBarLocation { get; set; }

Property Value

RibbonQuickAccessToolBarLocation:

A RibbonQuickAccessToolBarLocation that indicates the current location of the quick-access toolbar. The default value is Above.

public RibbonQuickAccessToolBarMode QuickAccessToolBarMode { get; set; }

Property Value

RibbonQuickAccessToolBarMode:

A RibbonQuickAccessToolBarMode that indicates the current display mode for the quick-access toolbar. The default value is Visible.

public Style QuickAccessToolBarStyle { get; set; }

Property Value

Style:

The Style that targets RibbonQuickAccessToolBar.

public ICommand RemoveFromQuickAccessToolBarCommand { get; }

Property Value

ICommand:

The ICommand used to remove an element passed in the command parameter from the quick-access toolbar.

public ICommand SetIsMinimizedCommand { get; }

Property Value

ICommand:

The ICommand to set the IsMinimized property to the bool command parameter value.

public ICommand SetLayoutModeCommand { get; }

Property Value

ICommand:

The ICommand to set the LayoutMode property to the RibbonLayoutMode command parameter value.

public ICommand SetQuickAccessToolBarLocationCommand { get; }

Property Value

ICommand:

The ICommand to set the QuickAccessToolBarLocation property to the RibbonQuickAccessToolBarLocation command parameter value.

public ICommand SetQuickAccessToolBarModeCommand { get; }

Property Value

ICommand:

The ICommand to set the QuickAccessToolBarMode property to the RibbonQuickAccessToolBarMode command parameter value.

public ICommand SetUserInterfaceDensityCommand { get; }

Property Value

ICommand:

The ICommand to set the UserInterfaceDensity property to the UserInterfaceDensity command parameter value.

public object TabRowToolBarContent { get; set; }

Property Value

object:

The tab row toolbar, which can either be a tab row toolbar view model that uses ItemContainerTemplateSelector for its UI, or a RibbonTabRowToolBar control instance.

public Style TabRowToolBarStyle { get; set; }

Property Value

Style:

The Style that targets RibbonTabRowToolBar.

public ICommand ToggleAllowLabelsOnQuickAccessToolBarCommand { get; }

Property Value

ICommand:

The ICommand used to toggle whether the quick-access toolbar allows labels.

public UserInterfaceDensity UserInterfaceDensity { get; set; }

Property Value

UserInterfaceDensity:

A UserInterfaceDensity that indicates how compact or spacious the UI should appear. The default value is Compact.

public void AddToQuickAccessToolBar(DependencyObject element)

Parameter	Type	Description
element	DependencyObject	The element to add.

public virtual bool CanAddToQuickAccessToolBar(DependencyObject element)

Parameter	Type	Description
element	DependencyObject	The element to examine.

Returns

bool:

true if the specified element can be added to the quick-access toolbar; otherwise, false.

public virtual bool CanRemoveFromQuickAccessToolBar(DependencyObject element)

Parameter	Type	Description
element	DependencyObject	The element to examine.

Returns

bool:

true if the specified element can be removed from the quick-access toolbar; otherwise, false.

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The item container element.
item	object	The data item.

protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject:

The element that is used to display the given item.

protected override bool IsItemItsOwnContainerOverride(object item)

Parameter	Type	Description
item	object	The item to check.

Returns

bool:

true if the item is (or is eligible to be) its own container; otherwise, false.

protected override Size MeasureOverride(Size availableSize)

Parameter	Type	Description
availableSize	Size

Returns

Size:

The size of the control, up to the maximum specified by constraint.

public override void OnApplyTemplate()

protected override void OnContextMenuOpening(ContextMenuEventArgs e)

Parameter	Type	Description
e	ContextMenuEventArgs	The RoutedEventArgs that contains the event data.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The type-specific AutomationPeer implementation.

protected virtual void OnIsCollapsedChanged(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	The RoutedEventArgs that contains the event data.

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	DependencyPropertyChangedEventArgs	The event data.

protected virtual void OnIsMinimizedChanged(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	The RoutedEventArgs that contains the event data.

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameter	Type	Description
e	NotifyCollectionChangedEventArgs	The event data.

protected override void OnKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	Information about the event.

protected virtual void OnKeyTipInvoked(KeyTipInvokedEventArgs e)

Parameter	Type	Description
e	KeyTipInvokedEventArgs	The KeyTipInvokedEventArgs containing data related to this event.

protected virtual void OnMenuOpening(BarMenuEventArgs e)

Parameter	Type	Description
e	BarMenuEventArgs	The BarMenuEventArgs that contains the event data.

protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameter	Type	Description
e	MouseWheelEventArgs	The MouseWheelEventArgs that contains the event data.

protected override void OnPreviewGotKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameter	Type	Description
e	KeyboardFocusChangedEventArgs	The KeyboardFocusChangedEventArgs that contains the event data.

protected override void OnPreviewLostKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameter	Type	Description
e	KeyboardFocusChangedEventArgs	The KeyboardFocusChangedEventArgs that contains the event data.

protected virtual void OnQuickAccessToolBarItemAdded(RibbonQuickAccessToolBarItemAddedEventArgs e)

Parameter	Type	Description
e	RibbonQuickAccessToolBarItemAddedEventArgs	The RibbonQuickAccessToolBarItemAddedEventArgs that contains the event data.

protected virtual void OnQuickAccessToolBarItemAdding(RibbonQuickAccessToolBarItemAddingEventArgs e)

Parameter	Type	Description
e	RibbonQuickAccessToolBarItemAddingEventArgs	The RibbonQuickAccessToolBarItemAddingEventArgs that contains the event data.

protected virtual void OnQuickAccessToolBarLocationChanged(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	The RoutedEventArgs that contains the event data.

protected virtual void OnQuickAccessToolBarModeChanged(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	The RoutedEventArgs that contains the event data.

protected override void OnSelectionChanged(SelectionChangedEventArgs e)

Parameter	Type	Description
e	SelectionChangedEventArgs	The event data.

public bool OpenContextMenuForElement(DependencyObject sourceObj)

Parameter	Type	Description
sourceObj	DependencyObject	The target System.Windows.DependencyObject.

Returns

bool:

true if a context menu was opened; otherwise, false.

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The element that is used to display the specified item.
item	object	The specified item to display.

public void RemoveFromQuickAccessToolBar(DependencyObject element)

Parameter	Type	Description
element	DependencyObject	The element to remove.

public override string ToString()

Returns

string:

The string representation of this object.

public event RoutedEventHandler IsCollapsedChanged

Event Type

RoutedEventHandler

public event RoutedEventHandler IsMinimizedChanged

Event Type

RoutedEventHandler

public event EventHandler<BarMenuEventArgs> MenuOpening

Event Type

EventHandler<BarMenuEventArgs>

public event EventHandler<RibbonQuickAccessToolBarItemAddedEventArgs> QuickAccessToolBarItemAdded

Event Type

EventHandler<RibbonQuickAccessToolBarItemAddedEventArgs>

public event EventHandler<RibbonQuickAccessToolBarItemAddingEventArgs> QuickAccessToolBarItemAdding

Event Type

EventHandler<RibbonQuickAccessToolBarItemAddingEventArgs>

public event RoutedEventHandler QuickAccessToolBarLocationChanged

Event Type

RoutedEventHandler

public event RoutedEventHandler QuickAccessToolBarModeChanged

Event Type

RoutedEventHandler

public static readonly DependencyProperty AllowLabelsOnQuickAccessToolBarProperty

public static readonly DependencyProperty ApplicationButtonContentProperty

public static readonly DependencyProperty ApplicationButtonStyleProperty

public static readonly DependencyProperty BackstageContentProperty

public static readonly DependencyProperty BackstageStyleProperty

public static readonly DependencyProperty CanChangeLayoutModeProperty

public static readonly DependencyProperty ClearFooterCommandProperty

public static readonly DependencyProperty CollapseThresholdSizeProperty

public static readonly DependencyProperty ContextualTabGroupsProperty

public static readonly DependencyProperty CornerRadiusProperty

public static readonly DependencyProperty FooterContentProperty

public static readonly DependencyProperty IsAnimationEnabledProperty

public static readonly DependencyProperty IsApplicationButtonVisibleProperty

public static readonly RoutedEvent IsCollapsedChangedEvent

public static readonly DependencyProperty IsCollapsedProperty

public static readonly DependencyProperty IsCollapsibleProperty

public static readonly DependencyProperty IsContentContainerVisibleProperty

public static readonly DependencyProperty IsFooterSeparatorVisibleProperty

public static readonly DependencyProperty IsFooterVisibleProperty

public static readonly DependencyProperty IsMinimizableProperty

public static readonly RoutedEvent IsMinimizedChangedEvent

public static readonly DependencyProperty IsMinimizedPopupOpenProperty

public static readonly DependencyProperty IsMinimizedProperty

public static readonly DependencyProperty IsOptionsButtonVisibleProperty

public static readonly DependencyProperty IsQuickAccessToolBarSeparatorVisibleProperty

public static readonly DependencyProperty ItemContainerTemplateSelectorProperty

public static readonly DependencyProperty LayoutModeProperty

public static readonly RoutedEvent MenuOpeningEvent

public static readonly DependencyProperty OptionsButtonKeyTipTextProperty

public static readonly DependencyProperty OptionsButtonLabelProperty

public static readonly DependencyProperty OptionsButtonToolTipProperty

public static readonly DependencyProperty QuickAccessToolBarContentProperty

public static readonly RoutedEvent QuickAccessToolBarItemAddedEvent

public static readonly RoutedEvent QuickAccessToolBarItemAddingEvent

public static readonly RoutedEvent QuickAccessToolBarLocationChangedEvent

public static readonly DependencyProperty QuickAccessToolBarLocationProperty

public static readonly RoutedEvent QuickAccessToolBarModeChangedEvent

public static readonly DependencyProperty QuickAccessToolBarModeProperty

public static readonly DependencyProperty QuickAccessToolBarStyleProperty

public static readonly DependencyProperty TabRowToolBarContentProperty

public static readonly DependencyProperty TabRowToolBarStyleProperty

public static readonly DependencyProperty UserInterfaceDensityProperty