RibbonQuickAccessToolBar Class

[TemplatePart(Name = "PART_InlineCustomizeButton", Type = typeof(RibbonQuickAccessToolBarCustomizeButton))]
[TemplatePart(Name = "PART_InlineOverflowButton", Type = typeof(RibbonQuickAccessToolBarOverflowPanel))]
[TemplatePart(Name = "PART_OverflowCustomizeButton", Type = typeof(RibbonQuickAccessToolBarCustomizeButton))]
[TemplatePart(Name = "PART_OverflowPanel", Type = typeof(RibbonQuickAccessToolBarOverflowButton))]
public class RibbonQuickAccessToolBar : ItemsControl, IOverflowingItemsControl, IOrientedElement

public RibbonQuickAccessToolBar()

public bool AllowLabels { get; set; }

Property Value

bool:

true if labels should be allowed on the items in the quick-access toolbar; otherwise, false.

public IList CommonItems { get; set; }

Property Value

IList:

The collection of common items that are available to be quickly added or removed from the Customize button.

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

Property Value

string:

The Customize button's key tip text.

public object CustomizeButtonToolTip { get; set; }

Property Value

object:

The Customize button's tooltip.

public bool IsCustomizeButtonVisible { get; set; }

Property Value

bool:

true if the Customize button is visible; otherwise, false.

public bool IsInWindowTitleBar { get; }

Property Value

bool:

true if the QAT is in the window's title bar; otherwise, false.

public bool IsOverflowed { get; }

Property Value

bool:

true if the control currently has overflowed items; otherwise, false.

public string KeyTipTextPrefix { get; set; }

Property Value

string:

The optional text to prefix the numbers used for QAT item key tip text.

Remarks

This property is useful when ribbon tab key tip text might start with a number that could conflict with the key tip text of a QAT item. In that scenario, setting the prefix to a letter such as Q could prevent conflicts.

public RibbonQuickAccessToolBarLocation Location { get; set; }

Property Value

RibbonQuickAccessToolBarLocation:

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

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

Property Value

string:

The Overflow button's key tip text.

public object OverflowButtonToolTip { get; set; }

Property Value

object:

The Overflow button's tooltip.

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The container element.
item	object	The 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.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The type-specific AutomationPeer implementation.

protected override void OnKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	Information about the event.

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 override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	Element used to display the specified item.
item	object	Specified item.

public static readonly DependencyProperty AllowLabelsProperty

public static readonly DependencyProperty CommonItemsProperty

public static readonly DependencyProperty CustomizeButtonKeyTipTextProperty

public static readonly DependencyProperty CustomizeButtonToolTipProperty

public static readonly DependencyProperty IsCustomizeButtonVisibleProperty

public static readonly DependencyProperty IsInWindowTitleBarProperty

public static readonly DependencyProperty IsOverflowedProperty

public static readonly DependencyProperty KeyTipTextPrefixProperty

public static readonly DependencyProperty LocationProperty

public static readonly DependencyProperty OverflowButtonKeyTipTextProperty

public static readonly DependencyProperty OverflowButtonToolTipProperty