Ribbon Class

[TemplatePart(Name = "PART_ApplicationButton", Type = typeof(ApplicationButton))]
[TemplatePart(Name = "PART_MinimizedPopup", Type = typeof(Popup))]
[TemplatePart(Name = "PART_TabStrip", Type = typeof(TabStrip))]
public class Ribbon : ContentControl, ILogicalParent

public Ribbon()

public ReadOnlyObservableCollection<Tab> ActiveTabs { get; }

Property Value

ReadOnlyObservableCollection<Tab>:

The ReadOnlyObservableCollection<Tab>containing the tabs that are active on the ribbon.

Remarks

This collection is rebuilt based on the Tab items in the Tabs and ContextualTabGroups collections.

public ImageSource ApplicationButtonImageSource { get; set; }

Property Value

ImageSource:

The ImageSource to use for the image on the application button.

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

Property Value

string:

The string label to display on the application button when using Scenic layout.

public object ApplicationButtonScreenTipDescription { get; set; }

Property Value

object:

The description object that will be displayed in screen tips for the application button.

public object ApplicationButtonScreenTipFooter { get; set; }

Property Value

object:

The footer object that will be displayed in screen tips for the application button.

public object ApplicationButtonScreenTipHeader { get; set; }

Property Value

object:

The header object that will be displayed in screen tips for the application button.

public Uri ApplicationButtonScreenTipHelpUri { get; set; }

Property Value

Uri:

The System.Uri specifying the location of context-sensitive help related to the application button when its screen tip is displayed and F1 is pressed.

public ImageSource ApplicationButtonScreenTipImageSource { get; set; }

Property Value

ImageSource:

The ImageSource for the image that will be displayed in screen tips for the application button.

public FrameworkElement ApplicationMenu { get; set; }

Property Value

FrameworkElement:

The FrameworkElement that represents the application menu.

Remarks

Set this property to either a ApplicationMenu or Backstage control depending on which UI style should be used for the application menu.

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.

Remarks

The default threshold size is 300, 250.

public ContextualTabGroupCollection ContextualTabGroups { get; }

Property Value

ContextualTabGroupCollection:

The ContextualTabGroupCollection containing the contextual tab groups that can be used with the ribbon.

public bool IsApplicationButtonVisible { get; set; }

Property Value

bool:

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

Remarks

When set to false, the application button hides and moves the QAT and tabs over.

public bool IsApplicationMenuOpen { get; set; }

Property Value

bool:

true if the ribbon's application menu is currently open; otherwise, false.

public bool IsCollapsed { get; set; }

Property Value

bool:

true if the ribbon is currently collapsed; otherwise, 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.

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.

public bool IsCustomizeQuickAccessToolBarMenuItemVisible { get; set; }

Property Value

bool:

true if a Customize Quick Access Toolbar menu item is visible; otherwise, false. The default value is false.

Remarks

When this menu item is made visible, be sure to handle the CustomizeQuickAccessToolBar command in your application.

public bool IsHostedInRibbonWindow { get; }

Property Value

bool:

true if the ribbon is hosted in a RibbonWindow; otherwise, false.

public bool IsKeyTipModeActive { get; }

Property Value

bool:

true if key tips are currently active for the ribbon; otherwise, false.

public bool IsKeyboardFocusBlurredOnWindowDeactivation { get; set; }

Property Value

bool:

true if keyboard focus is blurred from the ribbon when a containing window is deactivated; otherwise, false.

public bool IsMinimizable { get; set; }

Property Value

bool:

true if the ribbon is capable of being minimized by the end user; otherwise, false. The default value is true.

Remarks

If this property is true, UI will be added to context menus allowing for the toggling of the IsMinimized property. Additionally, double-clicking a Tab will toggle the IsMinimized property.

public bool IsMinimized { get; set; }

Property Value

bool:

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

Remarks

When minimized, the ribbon's groups are not visible until the end user clicks on a tab, at which point they display in a popup. This saves screen real estate.

public bool IsMinimizedPopupOpen { get; }

Property Value

bool:

true if the ribbon is currently minimized and its minimized popup is open; otherwise, false.

public bool IsQuickAccessToolBarCustomizationEnabled { get; set; }

Property Value

bool:

true if menu items are added; otherwise, false. The default value is true.

public bool IsQuickAccessToolBarCustomizeButtonVisible { get; set; }

Property Value

bool:

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

public bool IsRibbonWindowMaximized { get; }

Property Value

bool:

true if the ribbon is in a RibbonWindow that is currently maximized; otherwise, false.

public bool IsTabGroupVariantPreloadingEnabled { get; set; }

Property Value

bool:

true if the ribbon will pre-load all group variants for all tabs when the ribbon is loaded; otherwise, false. The default value is true.

Remarks

Due to the advanced layout/resizing capabilities of Ribbon, certain calculations must be performed to determine the size of each group variant. These calculations take a tiny amount of time. By setting this property to true, all calculations take place when the ribbon is first loaded. This slightly increases the startup time for the containing Window. If this property is false, the containing Window will start faster however the might be a slight lag the first time a Tab is clicked.

public bool IsToggleMinimizationButtonVisible { get; set; }

Property Value

bool:

true if the toggle minimization button should be visible in the ribbon when IsMinimizable is true; otherwise, false. The default value is true.

public bool IsWindowActive { get; set; }

Property Value

bool:

true if the containing Window is active; otherwise, false.

Remarks

Some user interface elements of the ribbon update when the containing Window is active.

public KeyTipModeShortcuts KeyTipModeShortcuts { get; set; }

Property Value

KeyTipModeShortcuts:

A KeyTipModeShortcuts that indicates the allowed shortcuts. The default value is All.

protected override IEnumerator LogicalChildren { get; }

Property Value

IEnumerator:

An enumerator for logical child elements of this element.

public RibbonControlCollection<UIElement> QuickAccessToolBarCommonItems { get; }

Property Value

RibbonControlCollection<UIElement>:

The RibbonControlCollection<UIElement> containing the common Quick Access ToolBar (QAT) items that can be displayed on the ribbon via the QAT Customize menu.

public RibbonControlCollection<UIElement> QuickAccessToolBarItems { get; }

Property Value

RibbonControlCollection<UIElement>:

The RibbonControlCollection<UIElement> containing the Quick Access ToolBar (QAT) items for display on the ribbon.

public QuickAccessToolBarLocation QuickAccessToolBarLocation { get; set; }

Property Value

QuickAccessToolBarLocation:

A QuickAccessToolBarLocation that indicates the location of the QAT.

Remarks

Set this property to QuickAccessToolBarLocation.None to hide the QAT completely.

public Tab SelectedTab { get; set; }

Property Value

Tab:

The currently selected Tab in the ribbon.

public RibbonControlCollection<UIElement> TabPanelItems { get; }

Property Value

RibbonControlCollection<UIElement>:

The RibbonControlCollection<UIElement> containing the tab panel items for display on the ribbon.

public RibbonControlCollection<Tab> Tabs { get; }

Property Value

RibbonControlCollection<Tab>:

The RibbonControlCollection<Tab> containing the tabs for display on the ribbon.

public FrameworkElement TargetContentContainer { get; set; }

Property Value

FrameworkElement:

The target FrameworkElement content container.

Remarks

This property is used to determine when the mouse is over the "content" area of the parent Window or Page.

protected override Size ArrangeOverride(Size arrangeBounds)

Parameter	Type	Description
arrangeBounds	Size	The final area within the parent that this element should use to arrange itself and its children.

Returns

Size:

The actual size used.

protected virtual ContextMenu CreateContextMenu(FrameworkElement element)

Parameter	Type	Description
element	FrameworkElement	The FrameworkElement for which to create a context menu.

Returns

ContextMenu:

The context menu that was created.

public ICollection<Exception> DeserializeQuickAccessToolBarItems(string xml)

Parameter	Type	Description
xml	string	The XML string containing data.

Returns

ICollection<Exception>:

A collection of Exception objects that specify any exceptions that may have occurred while loading items.

Remarks

The XML string must have been created by a previous call to SerializeQuickAccessToolBarItems().

public static Ribbon GetAncestorRibbon(UIElement element)

Parameter	Type	Description
element	UIElement	The UIElement to examine.

Returns

Ribbon:

The ancestor Ribbon for the element, if any.

protected override Geometry GetLayoutClip(Size layoutSlotSize)

Parameter	Type	Description
layoutSlotSize	Size	The layout slot size.

Returns

Geometry:

The clipping mask geometry.

protected override Size MeasureOverride(Size availableSize)

Parameter	Type	Description
availableSize	Size	The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Size:

The size that this element determines it needs during layout, based on its calculations of child element sizes.

protected virtual void OnApplicationButtonMouseDoubleClick(CancelRoutedEventArgs e)

Parameter	Type	Description
e	CancelRoutedEventArgs	A CancelRoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

Set the Cancel property of the event arguments to true to prevent the double-click from closing the parent Window.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The AutomationPeer that was created.

protected virtual void OnIsApplicationMenuOpenChanged(BooleanPropertyChangedRoutedEventArgs e)

Parameter	Type	Description
e	BooleanPropertyChangedRoutedEventArgs	A BooleanPropertyChangedRoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnIsCollapsedChanged(BooleanPropertyChangedRoutedEventArgs e)

Parameter	Type	Description
e	BooleanPropertyChangedRoutedEventArgs	A BooleanPropertyChangedRoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	DependencyPropertyChangedEventArgs	A System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

protected virtual void OnIsMinimizedChanged(BooleanPropertyChangedRoutedEventArgs e)

Parameter	Type	Description
e	BooleanPropertyChangedRoutedEventArgs	A BooleanPropertyChangedRoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override void OnKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	A KeyEventArgs that contains the event data.

protected override void OnMouseWheel(MouseWheelEventArgs e)

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

protected virtual void OnQuickAccessToolBarLocationChanged(RoutedEventArgs e)

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

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override void OnRenderSizeChanged(SizeChangedInfo sizeInfo)

Parameter	Type	Description
sizeInfo	SizeChangedInfo	Specifies the size changes.

protected virtual void OnSelectedTabChanged(TabPropertyChangedRoutedEventArgs e)

Parameter	Type	Description
e	TabPropertyChangedRoutedEventArgs	A PropertyChangedRoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnSelectedTabChanging(TabPropertyChangingRoutedEventArgs e)

Parameter	Type	Description
e	TabPropertyChangingRoutedEventArgs	A PropertyChangingRoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override void OnVisualParentChanged(DependencyObject oldParent)

Parameter	Type	Description
oldParent	DependencyObject	A System.Windows.DependencyObject that indicates the old visual parent.

public string SerializeQuickAccessToolBarItems()

Returns

string:

The XML string that contains the serialized data.

Remarks

Use the DeserializeQuickAccessToolBarItems(string) method to load the serialized data later.

public event EventHandler<CancelRoutedEventArgs> ApplicationButtonMouseDoubleClick

Event Type

EventHandler<CancelRoutedEventArgs>

public event EventHandler<BooleanPropertyChangedRoutedEventArgs> IsApplicationMenuOpenChanged

Event Type

EventHandler<BooleanPropertyChangedRoutedEventArgs>

public event EventHandler<BooleanPropertyChangedRoutedEventArgs> IsCollapsedChanged

Event Type

EventHandler<BooleanPropertyChangedRoutedEventArgs>

public event EventHandler<BooleanPropertyChangedRoutedEventArgs> IsMinimizedChanged

Event Type

EventHandler<BooleanPropertyChangedRoutedEventArgs>

public event RoutedEventHandler QuickAccessToolBarLocationChanged

Event Type

RoutedEventHandler

public event EventHandler<TabPropertyChangedRoutedEventArgs> SelectedTabChanged

Event Type

EventHandler<TabPropertyChangedRoutedEventArgs>

public event EventHandler<TabPropertyChangingRoutedEventArgs> SelectedTabChanging

Event Type

EventHandler<TabPropertyChangingRoutedEventArgs>

public static readonly DependencyProperty ApplicationButtonImageSourceProperty

public static readonly DependencyProperty ApplicationButtonLabelProperty

public static readonly RoutedEvent ApplicationButtonMouseDoubleClickEvent

public static readonly DependencyProperty ApplicationButtonScreenTipDescriptionProperty

public static readonly DependencyProperty ApplicationButtonScreenTipFooterProperty

public static readonly DependencyProperty ApplicationButtonScreenTipHeaderProperty

public static readonly DependencyProperty ApplicationButtonScreenTipHelpUriProperty

public static readonly DependencyProperty ApplicationButtonScreenTipImageSourceProperty

public static readonly DependencyProperty ApplicationMenuProperty

public static readonly DependencyProperty CollapseThresholdSizeProperty

public static readonly DependencyProperty IsApplicationButtonVisibleProperty

public static readonly RoutedEvent IsApplicationMenuOpenChangedEvent

public static readonly DependencyProperty IsApplicationMenuOpenProperty

public static readonly RoutedEvent IsCollapsedChangedEvent

public static readonly DependencyProperty IsCollapsedProperty

public static readonly DependencyProperty IsCollapsibleProperty

public static readonly DependencyProperty IsCustomizeQuickAccessToolBarMenuItemVisibleProperty

public static readonly DependencyProperty IsHostedInRibbonWindowProperty

public static readonly DependencyProperty IsKeyTipModeActiveProperty

public static readonly DependencyProperty IsKeyboardFocusBlurredOnWindowDeactivationProperty

public static readonly DependencyProperty IsMinimizableProperty

public static readonly RoutedEvent IsMinimizedChangedEvent

public static readonly DependencyProperty IsMinimizedPopupOpenProperty

public static readonly DependencyProperty IsMinimizedProperty

public static readonly DependencyProperty IsQuickAccessToolBarCustomizationEnabledProperty

public static readonly DependencyProperty IsQuickAccessToolBarCustomizeButtonVisibleProperty

public static readonly DependencyProperty IsRibbonWindowMaximizedProperty

public static readonly DependencyProperty IsTabGroupVariantPreloadingEnabledProperty

public static readonly DependencyProperty IsToggleMinimizationButtonVisibleProperty

public static readonly DependencyProperty IsWindowActiveProperty

public static readonly DependencyProperty KeyTipModeShortcutsProperty

public static readonly RoutedEvent QuickAccessToolBarLocationChangedEvent

public static readonly DependencyProperty QuickAccessToolBarLocationProperty

public static readonly RoutedEvent SelectedTabChangedEvent

public static readonly RoutedEvent SelectedTabChangingEvent

public static readonly DependencyProperty SelectedTabProperty

public static readonly DependencyProperty TargetContentContainerProperty